Author: sjur Date: Fri Jan 18 22:45:41 2013 New Revision: 1435390 URL: http://svn.apache.org/viewvc?rev=1435390&view=rev Log: Deployment of docs for org.apache.forrest.plugin.input.wiki plugin (deployed by 'deploy-docs' target of plugin build script)
Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.html forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.rss forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/samples/jspwiki-sample.html Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.html URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.html?rev=1435390&r1=1435389&r2=1435390&view=diff ============================================================================== --- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.html (original) +++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.html Fri Jan 18 22:45:41 2013 @@ -212,6 +212,10 @@ document.write("Last Published: " + docu Committed by RDG.</li> <li> <img class="icon" alt="fix" src="images/fix.jpg"> + Corrected a regression introduced in the previous fix. + Committed by SNM.</li> +<li> +<img class="icon" alt="fix" src="images/fix.jpg"> Added support for definition list constructs (<span class="codefrag">;Term:definition</span>). Fixed numerous spacing bugs: extra or missing spaces after inline elements. Improved support for inline formatting and breaks, especially in tables. Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.rss URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.rss?rev=1435390&r1=1435389&r2=1435390&view=diff ============================================================================== --- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.rss (original) +++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/changes.rss Fri Jan 18 22:45:41 2013 @@ -11,6 +11,13 @@ + <item><title>MyProject code fix</title><link>http://example.org/myproj//changes.html</link><description>code fix + by + SNM + : + + Corrected a regression introduced in the previous fix. + </description></item> <item><title>MyProject code add</title><link>http://example.org/myproj//changes.html</link><description>code add by SNM @@ -106,7 +113,13 @@ -<item><title>MyProject code add</title><link>http://example.org/myproj//changes.html</link><description>code add +<item><title>MyProject code fix</title><link>http://example.org/myproj//changes.html</link><description>code fix + by + SNM + : + + Corrected a regression introduced in the previous fix. + </description></item><item><title>MyProject code add</title><link>http://example.org/myproj//changes.html</link><description>code add by SNM : Modified: forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/samples/jspwiki-sample.html URL: http://svn.apache.org/viewvc/forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/samples/jspwiki-sample.html?rev=1435390&r1=1435389&r2=1435390&view=diff ============================================================================== --- forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/samples/jspwiki-sample.html (original) +++ forrest/site/pluginDocs/plugins_0_80/org.apache.forrest.plugin.input.wiki/samples/jspwiki-sample.html Fri Jan 18 22:45:41 2013 @@ -136,32 +136,27 @@ document.write("Last Published: " + docu <a href="#Quick+reference">Quick reference</a> </li> <li> -<a href="#Limitations">Limitations -</a> +<a href="#Limitations">Limitations</a> </li> </ul> </li> <li> -<a href="#Samples">Samples -</a> +<a href="#Samples">Samples</a> <ul class="minitoc"> <li> <a href="#Writing+text">Writing text</a> </li> <li> -<a href="#Hyperlinks">Hyperlinks -</a> +<a href="#Hyperlinks">Hyperlinks</a> </li> <li> <a href="#Adding+pictures">Adding pictures</a> </li> <li> -<a href="#Bulleted+lists">Bulleted lists -</a> +<a href="#Bulleted+lists">Bulleted lists</a> </li> <li> -<a href="#Numbered+lists">Numbered lists -</a> +<a href="#Numbered+lists">Numbered lists</a> </li> <li> <a href="#Definition+lists+and+comments">Definition lists and comments</a> @@ -183,21 +178,29 @@ document.write("Last Published: " + docu <a name="Forrest%27s+JSPWiki+Support"></a> <h2 class="underlined_10">Forrest's JSPWiki Support</h2> <div class="section"> -<p>Forrest now has partial support for documentation in JSPWiki format, thanks to the </p> -<p> -<a href="http://chaperon.sf.net/">Chaperon parser</a>. Wiki is a simple text format that can </p> -<p>be learned in minutes. This page provides an overview of the syntax that </p> -<p>Forrest supports, namely a subset of that used by the </p> -<p> -<a href="http://www.jspwiki.org/Wiki.jsp?page=TextFormattingRules">JSPWiki</a>. </p> -<p>There is also a </p> -<p> -<a href="http://www.jspwiki.org/Wiki.jsp?page=ChaperonTestPage">ChaperonTestPage</a> which </p> -<p>might provide some more hints (view its source). </p> +<p>Forrest now has partial support for documentation in JSPWiki format, thanks to the <softbreak column="83" line="3"> + +</softbreak> +<a href="http://chaperon.sf.net/">Chaperon parser</a>. Wiki is a simple text format that can <softbreak column="81" line="4"> + +</softbreak>be learned in minutes. This page provides an overview of the syntax that <softbreak column="73" line="5"> + +</softbreak>Forrest supports, namely a subset of that used by the <softbreak column="54" line="6"> + +</softbreak> +<a href="http://www.jspwiki.org/Wiki.jsp?page=TextFormattingRules">JSPWiki</a>. <softbreak column="68" line="7"> + +</softbreak>There is also a <softbreak column="16" line="8"> + +</softbreak> +<a href="http://www.jspwiki.org/Wiki.jsp?page=ChaperonTestPage">ChaperonTestPage</a> which <softbreak column="79" line="9"> + +</softbreak>might provide some more hints (view its source). </p> <a name="Important+Note"></a> <h3 class="underlined_5">Important Note</h3> -<p>It is very easy to create broken documents by using this loose wiki syntax. </p> -<p>Be sure to follow it explicitly. </p> +<p>It is very easy to create broken documents by using this loose wiki syntax. <softbreak column="76" line="14"> + +</softbreak>Be sure to follow it explicitly. </p> <a name="Quick+reference"></a> <h3 class="underlined_5">Quick reference</h3> <pre class="code"> @@ -229,101 +232,173 @@ __text__ = prints 'text' in bold. ;term:ex = makes a definition for 'term' with the explanation 'ex' </pre> <a name="Limitations"></a> -<h3 class="underlined_5">Limitations -</h3> -<p>These are the known limitations of the Forrest JSPWiki capability ... </p> +<h3 class="underlined_5">Limitations</h3> +<p> +<softbreak column="14" line="48"> + +</softbreak>These are the known limitations of the Forrest JSPWiki capability ... <softbreak column="70" line="49"> + +</softbreak> +</p> <ul> -<li>The "definition" syntax (;term: ex) is not supported. </li> +<li>The "definition" syntax (;term: ex) is not supported. <softbreak column="55" line="50"> + +</softbreak> +</li> <li>[link] = creates text '[link]' (is not working). </li> </ul> </div> <a name="Samples"></a> -<h2 class="underlined_10">Samples -</h2> +<h2 class="underlined_10">Samples</h2> <div class="section"> -<p>The following sections are samples. View the source to see their use </p> -<p>(no, not the source of this HTML page, but the actual wiki source from which </p> -<p>this page was generated). </p> +<p> +<softbreak column="11" line="53"> + +</softbreak>The following sections are samples. View the source to see their use <softbreak column="69" line="54"> + +</softbreak>(no, not the source of this HTML page, but the actual wiki source from which <softbreak column="77" line="55"> + +</softbreak>this page was generated). </p> <a name="Writing+text"></a> <h3 class="underlined_5">Writing text</h3> -<p>You don't need to know anything about the Wiki text formatting rules to use </p> -<p>Wiki. Just write normal text, and then use an empty line to mark a paragraph. </p> -<p>It is just like writing an email. Add more fancy items as you become more </p> -<p>comfortable. </p> +<p>You don't need to know anything about the Wiki text formatting rules to use <softbreak column="76" line="60"> + +</softbreak>Wiki. Just write normal text, and then use an empty line to mark a paragraph. <softbreak column="79" line="61"> + +</softbreak>It is just like writing an email. Add more fancy items as you become more <softbreak column="74" line="62"> + +</softbreak>comfortable. </p> <a name="Hyperlinks"></a> -<h3 class="underlined_5">Hyperlinks -</h3> -<p>The link can also be a direct URL starting with http: , ftp: , mailto: , https: , or news: , in which case the link points to </p> -<p>an external entity. For example, to point at the java.sun.com home page, use </p> +<h3 class="underlined_5">Hyperlinks</h3> +<p> +<softbreak column="13" line="65"> + +</softbreak>The link can also be a direct URL starting with http: , ftp: , mailto: , https: , or news: , in which case the link points to <softbreak column="121" line="66"> + +</softbreak>an external entity. For example, to point at the java.sun.com home page, use <softbreak column="77" line="67"> + +</softbreak> +</p> <pre class="code">[http://java.sun.com/]</pre> <p>which becomes <a href="http://java.sun.com/">http://java.sun.com/</a> +<softbreak column="37" line="69"> + +</softbreak> </p> <pre class="code">[Java home page|http://java.sun.com/]</pre> <p>which becomes <a href="http://java.sun.com/">Java home page</a> </p> <p>Almost any kind of characters can be used inside a </p> <pre class="code">[WikiName]</pre> -<p>as long </p> -<p>as they are letters or numbers. </p> +<p>as long <softbreak column="76" line="73"> + +</softbreak>as they are letters or numbers. </p> <a name="Adding+pictures"></a> <h3 class="underlined_5">Adding pictures</h3> -<p>For security reasons uploading images is not permitted, but you can embed </p> -<p>any image in the wiki code by putting the image available somewhere on the web in one of the allowed formats, and then </p> -<p>just linking to it. </p> -<p>For example, this is an inlined PNG image: <img alt="../images/icon.png" src="../images/icon.png">. </p> +<p>For security reasons uploading images is not permitted, but you can embed <softbreak column="74" line="78"> + +</softbreak>any image in the wiki code by putting the image available somewhere on the web in one of the allowed formats, and then <softbreak column="119" line="79"> + +</softbreak>just linking to it. <softbreak column="20" line="80"> + +</softbreak>For example, this is an inlined PNG image: <img alt="../images/icon.png" src="../images/icon.png">. </p> <p>If you specify a link text e.g. </p> <pre class="code">[this one here|http://example.org/example.png]</pre> -<p>then it becomes </p> -<p>the ALT text for those who either can't or don't want to view images. </p> +<p>then it becomes <softbreak column="101" line="83"> + +</softbreak>the ALT text for those who either can't or don't want to view images. </p> <a name="Bulleted+lists"></a> -<h3 class="underlined_5">Bulleted lists -</h3> -<p>Use an asterisk (*) in the first column to make bulleted lists. Use more asterisks for deeper indentation. For example: </p> +<h3 class="underlined_5">Bulleted lists</h3> +<p> +<softbreak column="17" line="86"> + +</softbreak>Use an asterisk (*) in the first column to make bulleted lists. Use more asterisks for deeper indentation. For example: <softbreak column="120" line="87"> + +</softbreak> +</p> <pre class="code"> * One * Two * Three ** Three.One </pre> -<p>creates </p> +<p>creates <softbreak column="8" line="95"> + +</softbreak> +</p> +<ul> +<li>One <softbreak column="6" line="96"> + +</softbreak> +</li> +<li>Two <softbreak column="6" line="97"> + +</softbreak> +</li> +<li>Three <softbreak column="8" line="98"> + +</softbreak> <ul> -<li>One </li> -<li>Two </li> -<li>Three <ul> <li>Three.One </li> </ul> </li> </ul> <a name="Numbered+lists"></a> -<h3 class="underlined_5">Numbered lists -</h3> -<p>Just like with bulleted lists, but use a hash (#) instead of the asterisk. Like this: </p> +<h3 class="underlined_5">Numbered lists</h3> +<p> +<softbreak column="17" line="101"> + +</softbreak>Just like with bulleted lists, but use a hash (#) instead of the asterisk. Like this: <softbreak column="86" line="102"> + +</softbreak> +</p> <pre class="code"> # One # Two # Three ## Three.One </pre> -<p>creates </p> +<p>creates <softbreak column="8" line="110"> + +</softbreak> +</p> +<ol> +<li>One <softbreak column="6" line="111"> + +</softbreak> +</li> +<li>Two <softbreak column="6" line="112"> + +</softbreak> +</li> +<li>Three <softbreak column="8" line="113"> + +</softbreak> <ol> -<li>One </li> -<li>Two </li> -<li>Three <ol> <li>Three.One </li> </ol> </li> </ol> -<p>If you want to write the list item on multiple lines, just add one or more spaces on the next line and the line will be </p> -<p>automatically added to the </p> -<p>previous item. If this sounds complicated, edit this page for an example, below. </p> -<ul> -<li>This is a single-line item. </li> -<li>This is actually a multi-line item. </li> -</ul> -<p>We continue the second sentence on a line on a line of its own. </p> -<p>We might as well do a third line while we're at it... </p> -<p>Notice, however, as all these sentences get rendered inside a single item! </p> +<p>If you want to write the list item on multiple lines, just add one or more spaces on the next line and the line will be <softbreak column="120" line="116"> + +</softbreak>automatically added to the <softbreak column="27" line="117"> + +</softbreak>previous item. If this sounds complicated, edit this page for an example, below. </p> <ul> +<li>This is a single-line item. <softbreak column="30" line="120"> + +</softbreak> +</li> +<li>This is actually a multi-line item. <softbreak column="38" line="121"> + +</softbreak>We continue the second sentence on a line on a line of its own. <softbreak column="66" line="122"> + +</softbreak>We might as well do a third line while we're at it... <softbreak column="56" line="123"> + +</softbreak>Notice, however, as all these sentences get rendered inside a single item! <softbreak column="77" line="124"> + +</softbreak> +</li> <li>The third line is again a single-line item. </li> </ul> <a name="Definition+lists+and+comments"></a> @@ -337,12 +412,19 @@ __text__ = prints 'text' in bold. <em>Something you use to do something with</em> </dd> </dl> -<p>Another nice use for the ';: ' is that you can use it to comment shortly on other people's text, by having an empty </p> -<p>'term' in the definition, like this: </p> +<p>Another nice use for the ';: ' is that you can use it to comment shortly on other people's text, by having an empty <softbreak column="115" line="133"> + +</softbreak>'term' in the definition, like this: <softbreak column="37" line="134"> + +</softbreak> +</p> <pre class="code"> ;:''Comment here.'' </pre> -<p>Which would be seen as </p> +<p>Which would be seen as <softbreak column="23" line="138"> + +</softbreak> +</p> <dl> <dt></dt> <dd> @@ -351,18 +433,23 @@ __text__ = prints 'text' in bold. </dl> <a name="Text+effects"></a> <h3 class="underlined_5">Text effects</h3> -<p>You may use <strong>bold</strong> text or <em>italic</em> text, by using two underscores (_) and two single quotes ('), respectively. If </p> -<p>you're on a Windows computer, make sure that you are using the correct quote sign, as there is one that looks the same, </p> -<p>but really isn't. </p> +<p>You may use <strong>bold</strong> text or <em>italic</em> text, by using two underscores (_) and two single quotes ('), respectively. If <softbreak column="119" line="143"> + +</softbreak>you're on a Windows computer, make sure that you are using the correct quote sign, as there is one that looks the same, <softbreak column="120" line="144"> + +</softbreak>but really isn't. </p> <a name="Preformatted+text"></a> <h3 class="underlined_5">Preformatted text</h3> -<p>If you want to add preformatted text (like code) just use three consecutive braces ({) to open a block, and three </p> -<p>consecutive braces (}) to close a block. See the Tables example below. </p> +<p>If you want to add preformatted text (like code) just use three consecutive braces ({) to open a block, and three <softbreak column="114" line="149"> + +</softbreak>consecutive braces (}) to close a block. See the Tables example below. </p> <a name="Tables"></a> <h3 class="underlined_5">Tables</h3> -<p>You can do simple tables by using using pipe symbols ('|'). Use double pipe </p> -<p>symbols to start the heading of a table, and single pipe symbols to then </p> -<p>write the rows of the table. End with a line that is not a table. </p> +<p>You can do simple tables by using using pipe symbols ('|'). Use double pipe <softbreak column="77" line="154"> + +</softbreak>symbols to start the heading of a table, and single pipe symbols to then <softbreak column="73" line="155"> + +</softbreak>write the rows of the table. End with a line that is not a table. </p> <p>For example: </p> <pre class="code"> || Heading 1 || Heading 2