You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2011/09/10 17:08:24 UTC

svn commit: r1167530 - in /maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site: apt/development.apt fml/faq.fml xdoc/index.xml xdoc/usage.xml

Author: hboutemy
Date: Sat Sep 10 15:08:24 2011
New Revision: 1167530

URL: http://svn.apache.org/viewvc?rev=1167530&view=rev
Log:
little documentation improvements

Modified:
    maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/apt/development.apt
    maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/fml/faq.fml
    maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/index.xml
    maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/usage.xml

Modified: maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/apt/development.apt
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/apt/development.apt?rev=1167530&r1=1167529&r2=1167530&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/apt/development.apt (original)
+++ maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/apt/development.apt Sat Sep 10 15:08:24 2011
@@ -70,7 +70,7 @@ Development of Apache Doxia Eclipse Plug
 
 +-------------------------------+
 mvn clean install -f doxia-osgi/pom.xml
-|_ Makes an OSGi bundle of doxia.
+|_ Makes an OSGi bundle of Doxia.
 
 +-------------------------------+
 

Modified: maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/fml/faq.fml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/fml/faq.fml?rev=1167530&r1=1167529&r2=1167530&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/fml/faq.fml (original)
+++ maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/fml/faq.fml Sat Sep 10 15:08:24 2011
@@ -27,7 +27,7 @@ under the License.
    <faq id="Why using this plugin?">
      <question>Why using this plugin?</question>
      <answer>
-       <p>Why are you using IDEs? To help you! Same here.</p>
+       <p>Why are you using an IDE? To help you! Same here.</p>
      </answer>
    </faq>
  </part>

Modified: maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/index.xml?rev=1167530&r1=1167529&r2=1167530&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/index.xml (original)
+++ maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/index.xml Sat Sep 10 15:08:24 2011
@@ -44,35 +44,36 @@ under the License.
       </p>
       <subsection name="What can Apache Doxia Eclipse Plugin do for you?">
         <p>
-          This Eclipse Plugin :
+          This Eclipse Plugin:
         </p>
         <ul>
-          <li>Supports all Apache Doxia files</li>
-          <li>Shows the rendering of any Apache Doxia files directly, without running mvn site</li>
-          <li>Supports color and styles in the editors</li>
+          <li>Supports all Apache Doxia file formats</li>
+          <li>Shows the rendering of any Apache Doxia files directly, without running <code>mvn site</code></li>
+          <li>Supports color and styles highlighting in the editors</li>
+          <li>Provides helpers to insert commonly used patterns in each format (bold, italic, code, table)</li>
           <li>Includes wizards for creating new Apache Doxia files</li>
         </ul>
         <p>
-          See the <a href="usage.html">usage</a> for more information.
+          See the <a href="usage.html">usage page</a> for more information.
         </p>
       </subsection>
       <subsection name="Brief History">
         <p>
            This project was started in 2008 by Vincent Siveton (see <a href="http://jira.codehaus.org/browse/DOXIATOOLS-8">DOXIATOOLS-8</a>)
-           but was never released. In August 2011, Hervé Boutémy wanted to revive the project. Benson Margulies was willing to help
+           but was never released. In August 2011, Hervé Boutemy wanted to revive the project. Benson Margulies was willing to help
            by making a correct Maven build using OSGi and Tycho. Here we go now.
         </p>
       </subsection>
       <subsection name="Installation">
         <p>
-          Use the Eclipse update manager to install this plugin:
+          Use the Eclipse Update Manager to install this plugin:
         </p>
         <pre class="source">Go to "Help -> Install New Software... -> Work with:"</pre>
         <p>
           You can use the following update site from within Eclipse: <a href="./eclipse">eclipse</a>.
         </p>
         <p>
-          You could also use the update site generated by Jenkins CI server:<br/>
+          You can also use the update site generated by ASF's Jenkins CI server to get the latest updates:<br/>
           <a href="https://builds.apache.org/view/M-R/view/Maven/job/doxia-eclipse-editor/ws/doxia-ide-eclipse/eclipse-plugins/features/org.apache.maven.doxia.ide.eclipse.feature/target/site/">
           https://builds.apache.org/view/M-R/view/Maven/job/doxia-eclipse-editor/ws/doxia-ide-eclipse/eclipse-plugins/features/org.apache.maven.doxia.ide.eclipse.feature/target/site/</a>.
         </p>

Modified: maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/usage.xml
URL: http://svn.apache.org/viewvc/maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/usage.xml?rev=1167530&r1=1167529&r2=1167530&view=diff
==============================================================================
--- maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/usage.xml (original)
+++ maven/sandbox/trunk/doxia/doxia-ide/eclipse/site/src/site/xdoc/usage.xml Sat Sep 10 15:08:24 2011
@@ -43,7 +43,7 @@ under the License.
       </subsection>
       <subsection name="Features">
         <p>
-          You could modify the text styles using the menu bar or using the right click button. You could also create Doxia
+          You can modify the text styles using the menu bar or using the right click button. You can also create Doxia
           files using Wizard.
         </p>
         <ul>