Skip to content

Commit

Permalink
docs: correct namespaces
Browse files Browse the repository at this point in the history
  • Loading branch information
philipsens committed Nov 27, 2023
1 parent 10516fc commit c5900cf
Show file tree
Hide file tree
Showing 22 changed files with 74 additions and 74 deletions.
4 changes: 2 additions & 2 deletions docs/source/advancedDevelopment/deployment/executeJar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@ The output should include:

.. code-block:: none
[DEBUG] Executing command line: [C:\Program Files (x86)\Common Files\Oracle\Java\javapath\java.exe, -classpath, C:\Users\martijn\frank-manual\srcSteps\mavenWebapp\v510\target\classes;C:\Users\martijn\.m2\repository\org\apache\commons\commons-lang3\3.12.0\commons-lang3-3.12.0.jar, org.wearefrank.maven.webapp.example.Main]
[DEBUG] Executing command line: [C:\Program Files (x86)\Common Files\Oracle\Java\javapath\java.exe, -classpath, C:\Users\martijn\frank-manual\srcSteps\mavenWebapp\v510\target\classes;C:\Users\martijn\.m2\repository\org\apache\commons\commons-lang3\3.12.0\commons-lang3-3.12.0.jar, org.frankframework.maven.webapp.example.Main]
The output is a comma-separated list of the arguments used to start ``java.exe``. You see here that ``java.exe`` was executed like this:

.. code-block:: none
C:\Program Files (x86)\Common Files\Oracle\Java\javapath\java.exe -classpath C:\Users\martijn\frank-manual\srcSteps\mavenWebapp\v510\target\classes;C:\Users\martijn\.m2\repository\org\apache\commons\commons-lang3\3.12.0\commons-lang3-3.12.0.jar org.wearefrank.maven.webapp.example.Main
C:\Program Files (x86)\Common Files\Oracle\Java\javapath\java.exe -classpath C:\Users\martijn\frank-manual\srcSteps\mavenWebapp\v510\target\classes;C:\Users\martijn\.m2\repository\org\apache\commons\commons-lang3\3.12.0\commons-lang3-3.12.0.jar org.frankframework.maven.webapp.example.Main
5. Please run this command directly on a command prompt. You may have to quote some words and you may have to adjust some directory names depending on your operating system and your work directory.

Expand Down
10 changes: 5 additions & 5 deletions docs/source/advancedDevelopment/deployment/mavenBasics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ Maven can best be introduced using a simple Hello World application. Please do t

1. Choose some work directory, say ``work``.
#. Within ``work``, create folder ``src/main/java``. This is where Maven expects Java sources.
#. Within ``work/src/main/java``, open ``org/wearefrank/maven/webapp/example/Main.java``. Populate it with the following text:
#. Within ``work/src/main/java``, open ``org/frankframework/maven/webapp/example/Main.java``. Populate it with the following text:

.. literalinclude:: ../../../../srcSteps/mavenWebapp/v500/src/main/java/org/wearefrank/maven/webapp/example/Main.java
.. literalinclude:: ../../../../srcSteps/mavenWebapp/v500/src/main/java/org/frankframework/maven/webapp/example/Main.java

This is a program that should be started from the command line. It simply prints "HELLO WORLD!". To demonstrate Maven, a dependency has been introduced. This program needs Java class ``org.apache.commons.lang3.StringUtils``.

Expand Down Expand Up @@ -112,14 +112,14 @@ The output should look like this:
│ └───main
│ └───java
│ └───org
│ └───wearefrank
│ └───frankframework
│ └───maven
│ └───webapp
│ └───example
└───target
├───classes
│ └───org
│ └───wearefrank
│ └───frankframework
│ └───maven
│ └───webapp
│ └───example
Expand All @@ -132,7 +132,7 @@ The output should look like this:
C:\Users\martijn\frank-manual\srcSteps\mavenWebapp\v500>
All generated files appear in the ``target`` directory. Within that directory, there is a directory ``classes``. This directory holds everything that this artifact will put on the classpath when the linked application executes. There is a path ``org/wearefrank/maven/webapp/example``. This path resembles the path to file ``Main.java``. The directory holds file ``Main.class``, the byte code produced by compiling source file ``Main.java`` (not shown).
All generated files appear in the ``target`` directory. Within that directory, there is a directory ``classes``. This directory holds everything that this artifact will put on the classpath when the linked application executes. There is a path ``org/frankframework/maven/webapp/example``. This path resembles the path to file ``Main.java``. The directory holds file ``Main.class``, the byte code produced by compiling source file ``Main.java`` (not shown).

11. Assemble the artifact of this project, which has ``<groupId>`` ``org.ibissource``, ``<artifactId>`` ``mavenWebappExample`` and ``<version>`` ``1.0-SNAPSHOT``. Do so by entering ``mvn install``.
#. Check that you have file ``mavenWebappExample-1.0-SNAPSHOT.jar``. This is a ZIP file that holds all data that this artifact should put on the classpath.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/advancedDevelopment/deployment/mavenWebapp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ Maven webapplications are usually not executed by starting the JVM directly. Ins
Webapplications do network communication using the Hypertext Transfer Protocol (HTTP). First, update the ``Main`` class of subsection :ref:`advancedDevelopmentDeploymentMavenMavenBasics` to talk HTTP:

#. Undo the changes of subsection :ref:`advancedDevelopmentDeploymentMavenExecuteJar` by restoring the copy you made at the beginning of that subsection.
#. Change file ``work/src/main/java/org/wearefrank/maven/webapp/example/Main.java`` to become as follows:
#. Change file ``work/src/main/java/org/frankframework/maven/webapp/example/Main.java`` to become as follows:

.. literalinclude:: ../../../../srcSteps/mavenWebapp/v520/src/main/java/org/wearefrank/maven/webapp/example/Main.java
.. literalinclude:: ../../../../srcSteps/mavenWebapp/v520/src/main/java/org/frankframework/maven/webapp/example/Main.java

#. Link this servlet to the URL that should trigger it. Do so by creating file ``work/src/main/webapp/WEB-INF/web.xml`` and give it the following contents:

Expand Down
4 changes: 2 additions & 2 deletions docs/source/gettingStarted/exercise.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@ Here is an example of an input XML message to be processed:
.. literalinclude:: ../../../srcSteps/exercise/v500/tests/Conclusion/valid.xml
:language: xml

All elements of this request have namespace ``http://wearefrank.nl/manual/exercise/conclusion``.
All elements of this request have namespace ``http://frankframework.org/manual/exercise/conclusion``.

This message should be transformed according to the following:

* Mundo needs an XML in which every element has namespace ``http://wearefrank.nl/manual/exercise/mundo``.
* Mundo needs an XML in which every element has namespace ``http://frankframework.org/manual/exercise/mundo``.
* The ``<to>`` and ``<cc>`` elements are wrapped inside a ``<header>``.
* The ``<accountId>``, ``<email>``, ``<street>``, ``<houseNumber>``, ``<city>``, ``<zip>`` and ``<country>`` inside ``<to>`` and ``<cc>`` elements remain the same apart from the namespace.
* The ``<firstName>`` and ``<lastName>`` elements of a Conclusion request are not copied. Their values are combined and the resulting string is wrapped in an element ``<displayName>``.
Expand Down
26 changes: 13 additions & 13 deletions docs/source/gettingStarted/validMundo.xml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
<document
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://wearefrank.nl/manual/exercise/mundo"
xmlns="http://frankframework.org/manual/exercise/mundo"
id="abcdefgh" >
<header>
<to>
<accountId>12345</accountId>
<displayName>Frank</displayName>
<email>info@wearefrank.nl</email>
<street>Westersingel</street>
<houseNumber>42</houseNumber>
<city>Rotterdam</city>
<zip>3014GT</zip>
<country>The Netherlands</country>
<email>info@frankframework.org</email>
<street>Example Street</street>
<houseNumber>1</houseNumber>
<city>Example City</city>
<zip>1234AB</zip>
<country>Example country</country>
</to>
<cc>
<accountId>12346</accountId>
<displayName>Frits</displayName>
<email>frits@wearefrank.nl</email>
<street>Blaak</street>
<houseNumber>1</houseNumber>
<city>Rotterdam</city>
<zip>3016ZZ</zip>
<country>The Netherlands</country>
<email>frits@frankframework.org</email>
<street>Other Example Street</street>
<houseNumber>2</houseNumber>
<city>Other Example City</city>
<zip>5678CD</zip>
<country>Example country</country>
</cc>
</header>
<!-- Base64 encoded "The document contents" -->
Expand Down
2 changes: 1 addition & 1 deletion docs/source/snippets/mavenWebapp/v510/addPlugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<arguments>
<argument>-classpath</argument>
<classpath/>
<argument>org.wearefrank.maven.webapp.example.Main</argument>
<argument>org.frankframework.maven.webapp.example.Main</argument>
</arguments>
</configuration>
</plugin>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/snippets/mavenWebapp/v510/addPlugin.txt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<arguments>
<argument>-classpath</argument>
<classpath/>
<argument>org.wearefrank.maven.webapp.example.Main</argument>
<argument>org.frankframework.maven.webapp.example.Main</argument>
</arguments>
</configuration>
</plugin>
Expand Down
2 changes: 1 addition & 1 deletion docs/source/snippets/mavenWebapp/v520/java.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
```none
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;
import org.apache.commons.lang3.StringUtils;
import javax.servlet.ServletException;
Expand Down
2 changes: 1 addition & 1 deletion docs/source/snippets/mavenWebapp/v520/java.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. code-block:: none

package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;
import javax.servlet.ServletException;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<xsl:transform xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:input="http://wearefrank.nl/manual/exercise/conclusion"
xmlns:output="http://wearefrank.nl/manual/exercise/mundo"
xmlns:input="http://frankframework.org/manual/exercise/conclusion"
xmlns:output="http://frankframework.org/manual/exercise/mundo"
version="2.0">
<xsl:param name="body" as="xs:string" />
<xsl:template match="/input:document">
Expand All @@ -14,7 +14,7 @@
</output:document>
</xsl:template>
<xsl:template match="input:*">
<xsl:element name="{local-name()}" namespace="http://wearefrank.nl/manual/exercise/mundo">
<xsl:element name="{local-name()}" namespace="http://frankframework.org/manual/exercise/mundo">
<xsl:apply-templates />
</xsl:element>
</xsl:template>
Expand Down
4 changes: 2 additions & 2 deletions srcSteps/exercise/v500/configurations/Conclusion/xmlInput.xsd
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:input="http://wearefrank.nl/manual/exercise/conclusion"
targetNamespace="http://wearefrank.nl/manual/exercise/conclusion"
xmlns:input="http://frankframework.org/manual/exercise/conclusion"
targetNamespace="http://frankframework.org/manual/exercise/conclusion"
elementFormDefault="qualified">
<xs:element name="document">
<xs:complexType>
Expand Down
36 changes: 18 additions & 18 deletions srcSteps/exercise/v500/tests/Conclusion/expectedMessageToMundo.xml
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
<?xml version="1.0" encoding="UTF-8"?><output:document id="abcdefgh" xmlns:input="http://wearefrank.nl/manual/exercise/conclusion" xmlns:output="http://wearefrank.nl/manual/exercise/mundo" xmlns:xs="http://www.w3.org/2001/XMLSchema"><output:header>
<to xmlns="http://wearefrank.nl/manual/exercise/mundo">
<?xml version="1.0" encoding="UTF-8"?><output:document id="abcdefgh" xmlns:input="http://frankframework.org/manual/exercise/conclusion" xmlns:output="http://frankframework.org/manual/exercise/mundo" xmlns:xs="http://www.w3.org/2001/XMLSchema"><output:header>
<to xmlns="http://frankframework.org/manual/exercise/mundo">
<accountId>12345</accountId>
<output:displayName>Frank Frank</output:displayName>
<email>info@wearefrank.nl</email>
<street>Westersingel</street>
<houseNumber>42</houseNumber>
<city>Rotterdam</city>
<zip>3014GT</zip>
<country>The Netherlands</country>
<output:displayName>Frank</displayName>

<email>info@frankframework.org</email>
<street>Example Street</street>
<houseNumber>1</houseNumber>
<city>Example City</city>
<zip>1234AB</zip>
<country>Example country</country>
</to>
<cc xmlns="http://wearefrank.nl/manual/exercise/mundo">
<cc xmlns="http://frankframework.org/manual/exercise/mundo">
<accountId>12346</accountId>
<output:displayName>Frits Frits</output:displayName>
<output:displayName>Frits</displayName>

<email>frits@wearefrank.nl</email>
<street>Blaak</street>
<houseNumber>1</houseNumber>
<city>Rotterdam</city>
<zip>3016ZZ</zip>
<country>The Netherlands</country>
<email>frits@frankframework.org</email>
<street>Other Example Street</street>
<houseNumber>2</houseNumber>
<city>Other Example City</city>
<zip>5678CD</zip>
<country>Example country</country>
</cc>
</output:header><output:body>VGhlIGRvY3VtZW50
</output:body></output:document>
28 changes: 14 additions & 14 deletions srcSteps/exercise/v500/tests/Conclusion/valid.xml
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
<document
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://wearefrank.nl/manual/exercise/conclusion"
xmlns="http://frankframework.org/manual/exercise/conclusion"
id="abcdefgh" >
<to>
<accountId>12345</accountId>
<firstName>Frank</firstName>
<lastName>Frank</lastName>
<email>info@wearefrank.nl</email>
<street>Westersingel</street>
<houseNumber>42</houseNumber>
<city>Rotterdam</city>
<zip>3014GT</zip>
<country>The Netherlands</country>
<email>info@frankframework.org</email>
<street>Example Street</street>
<houseNumber>1</houseNumber>
<city>Example City</city>
<zip>1234AB</zip>
<country>Example country</country>
</to>
<cc>
<accountId>12346</accountId>
<firstName>Frits</firstName>
<lastName>Frits</lastName>
<email>frits@wearefrank.nl</email>
<street>Blaak</street>
<houseNumber>1</houseNumber>
<city>Rotterdam</city>
<zip>3016ZZ</zip>
<country>The Netherlands</country>
<lastName>Frank</lastName>
<email>frits@frankframework.org</email>
<street>Other Example Street</street>
<houseNumber>2</houseNumber>
<city>Other Example City</city>
<zip>5678CD</zip>
<country>Example country</country>
</cc>
</document>
2 changes: 1 addition & 1 deletion srcSteps/mavenWebapp/v480/meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@
path: pom.xml
change: add
- file:
path: src/main/java/org/wearefrank/maven/webapp/example/Main.java
path: src/main/java/org/frankframework/maven/webapp/example/Main.java
change: add
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;

Expand Down
2 changes: 1 addition & 1 deletion srcSteps/mavenWebapp/v510/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<arguments>
<argument>-classpath</argument>
<classpath/>
<argument>org.wearefrank.maven.webapp.example.Main</argument>
<argument>org.frankframework.maven.webapp.example.Main</argument>
</arguments>
</configuration>
</plugin>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;

Expand Down
2 changes: 1 addition & 1 deletion srcSteps/mavenWebapp/v520/meta.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
snippet: pomDepBuild
highlight: true
- file:
path: src/main/java/org/wearefrank/maven/webapp/example/Main.java
path: src/main/java/org/frankframework/maven/webapp/example/Main.java
change:
- old: 7
new: 12
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package org.wearefrank.maven.webapp.example;
package org.frankframework.maven.webapp.example;

import org.apache.commons.lang3.StringUtils;
import javax.servlet.ServletException;
Expand Down
2 changes: 1 addition & 1 deletion srcSteps/mavenWebapp/v520/src/main/webapp/WEB-INF/web.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
version="3.1">
<servlet>
<servlet-name>hello</servlet-name>
<servlet-class>org.wearefrank.maven.webapp.example.Main</servlet-class>
<servlet-class>org.frankframework.maven.webapp.example.Main</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>hello</servlet-name>
Expand Down

0 comments on commit c5900cf

Please sign in to comment.