THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
...
Shortcut | Purpose | Usage | Result | ||
|---|---|---|---|---|---|
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd8d1d8289c3d387-9b00fe34-410d4f17-9e5cada8-3756ec6b68187d36370a51b1"><ac:plain-text-body><![CDATA[ | primer | A bookmark in our Key Technologies Primer | [javabeans@primer] | [javabeans@primer] | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9679349fee87207f-0e07c354-491f4892-960aa0e6-38fcd740cb97dfbfe65c86f7"><ac:plain-text-body><![CDATA[ | s2jira | A ticket in our issue tracker | [WW-2111@s2jira] | [WW-2111@s2jira] | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="cd39849d86ecd7d5-c3f79c20-4e8b47be-b23d9722-d9a1693b429cb16769c54793"><ac:plain-text-body><![CDATA[ | s2plugins | S2 Plugin Repository | [tiles-plugin.html@s2plugins] | [tiles-plugin.html@s2plugins] | ]]></ac:plain-text-body></ac:structured-macro> |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="305b42154c67f04c-b8431c7b-47fa470c-802eb6b2-ba1393e3504348c63888bbd9"><ac:plain-text-body><![CDATA[ | s2site | The Struts 2 website | [docs/home.html@s2site] | [docs/home.html@s2site] | ]]></ac:plain-text-body></ac:structured-macro> |
...
A URL must start with a valid prefix. Currently there There are two valid prefixes that are useful for Struts documentation purposes.types of prefixes:
- com.opensymphony.xwork2. (notice the period)
- struts2/ (notice the trailing slash)
- Notice the period. This syntax is better when you want to include content from a class because they allow you to use the fully qualified classname as the URL.
- struts2/ Notice the trailing slash. This syntax better when you want to include content content from non-class files such as xml or properties files. They may also be needed if a class based prefix for a sub-project has not be setup.
To include a snippet from http://svn.apache.org/repos/asf/struts/struts2/trunk/apps/showcase/src/main/java/org/apache/struts2/showcase/DateAction.java
the two possible methods are:
| Code Block |
|---|
{snippet:lang=java|url=struts2/apps/showcase/src/main/java/org/apache/struts2/showcase/DateAction.java}
{snippet:lang=java|url=struts2/apps.showcase.src.main.java.org.apache.struts2.showcase.DateAction}
|
To include a snippet from http://svn.opensymphony.com/svn/xwork/trunk/src/java/com/opensymphony/xwork2/validator/validators/StringLengthFieldValidator.java the two possible methods are:
| Code Block |
|---|
{snippet:id=javadoc|javadoc=true|url=com.opensymphony.xwork2.validator.validators.StringLengthFieldValidator}
{snippet:id=javadoc|javadoc=true|url=com.opensymphony.xwork2.validator/validators/StringLengthFieldValidator.java}
|
The list of available prefixes:
Prefix | Destination | ||
|---|---|---|---|
xwork2/ | http://svn.opensymphony.com/svn/xwork/trunk/ | ||
struts2/ | http://svn.apache.org/repos/asf/struts/struts2/trunk/ | ||
rest-plugin/ | http://svn.apache.org/repos/asf/struts/struts2/trunk/plugins/rest/ | ||
struts2-tags/ | http://svn.apache.org/repos/asf/struts/struts2/trunk/core/src/site/resources/tags/ | Prefix | Destination |
com.opensymphony.xwork2. | http://svn.opensymphony.com/svn/xwork/trunk/src/java/com/opensymphony/xwork2/ | ||
org.apache.struts2/. | http://svn.apache.org/repos/asf/struts/struts2/trunk/core/src/main/java/org/apache/struts2/ |
...
org.apache.struts2.dojo. | http://svn.apache.org/repos/asf/struts/struts2/trunk/ |
...
...
| dojo/src/main/java/org/apache/struts2/dojo/ |
org.apache.struts2 |
...
...
...
| sitegraph/ |
org.apache.struts2. |
...
sitemesh. |
...
...
...
...
...
...
...
...
...
org.apache.struts2.views.tiles. | http://svn.apache.org/repos/asf/struts/struts2/trunk/plugins/tiles/src/main/java/org/apache/struts2/views/tiles/ |
...
About snippet markers
When possible, all snippet markers should be in comment blocks. How they are commented depends on where the snippet is being embedded.
...
A <pre> tag within a Javadoc comment would be escaped and rendered as part of the snippet. See TimerInterceptor.java for an complete example.