Changeset 392

Show
Ignore:
Timestamp:
02/09/10 04:46:27 (6 months ago)
Author:
tormp
Message:

fix minor typos and errata

Location:
trunk/src/documentation
Files:
4 modified

Legend:

Unmodified
Added
Removed

  • trunk/src/documentation/changelog.html

    r391 r392  
    2929<ul> 
    3030  <li>use latest official ant (no more a patched version)</li> 
    31   <li>refactor ancontrib usage, antcontrib is now considered as a dependency of easyant-core</li> 
    32   <li>add the capabilty to override target/phases defined in module.ivy (ovveride.module.ant)</li> 
     31  <li>refactor antcontrib usage, antcontrib is now considered as a dependency of easyant-core</li> 
     32  <li>add the capabilty to override target/phases defined in module.ivy (override.module.ant)</li> 
    3333  <li>enhanced multimodule support 
    3434    <ul> 
     35      <li>full support for all standard build phases</li> 
     36      <li>full support for Ivy descriptor "extends"</li> 
    3537      <li>build-scoped repository should allow overwrites (#74)</li> 
    3638      <li>meta-build: better support for custom ivysettings.xml (#75)</li> 
    37       <li>TODO : NEW FEATURES</li> 
    3839    </ul> 
    3940  </li> 
    … …  
    4142  <li>use cache by default instead of retrieving in lib directory</li> 
    4243  <li>simplify version management : uses revision attribute in module.ivy instead of a specific property (#81)</li> 
    43   <li>simplify syntax of easyant tags, plugins/buildtypes now support two way to be imported (#84): 
     44  <li>simplify syntax of easyant tags, plugins/buildtypes now support two ways to be imported (#84): 
    4445     <ul> 
    4546       <li>using mrid <code type="xml"><plugin mrid="org.apache.easyant.plugins#run-java;0.1"/></code></li> 

  • trunk/src/documentation/howto/GettingStarted.html

    r385 r392  
    6767<p /> 
    6868This file is the module descriptor of your project.  
    69 It contains several informations like your company name, the module name, dependencies, and Easyant build information. 
     69It contains information like your company name, the module name, dependencies, and Easyant build information. 
    7070 
    7171<h3>A short example</h3> 
    … …  
    9090Pay attention to the <ea:build> tag. 
    9191This tags define which build-type is used for your project. In this example we use <b>build-std-java</b> which provides all the targets necessary to compile / package a standard java application. 
    92 <div id="note">Note: The organisation argument in <b>ea:build</b> tag is optionnal. If not specified easyant will use the default one (org.apache.easyant.buildtypes).</div> 
     92<div id="note">Note: The organisation argument in <b>ea:build</b> tag is optional. If not specified easyant will use the default one (org.apache.easyant.buildtypes).</div> 
    9393 
    9494Running easyant with this example will run the default target (package). 
    … …  
    123123</code> 
    124124As you can see the target is prefixed by the project name. 
    125 Most of the time the project name is quite long so easyant allows you to define a aliases for the project names. Such an alias can be used in place of the complete project name. You can define an alias for a plugin using "as" argument as below. 
     125Most of the time the project name is quite long so easyant allows you to define aliases for the project names. Such an alias can be used in place of the complete project name. You can define an alias for a plugin using "as" argument as below. 
    126126<code type="xml"> 
    127127<ea:build organisation="org.apache.easyant.buildtypes" module="build-std-java" revision="0.2"/> 
    … …  
    132132Calling to "easyant -p" we should see the emma public target : 
    133133<code type="xml"> 
    134 emma.:emma generate emma covera report 
     134emma:emma generate emma covera report 
    135135</code> 
    136 <div id="note">Note: The organisation argument in <b>ea:plugin</b> tag is optionnal. If not specified easyant will use the default one (org.apache.easyant.plugins).</div> 
     136<div id="note">Note: The organisation argument in <b>ea:plugin</b> tag is optional. If not specified easyant will use the default one (org.apache.easyant.plugins).</div> 
    137137 
    138138<h3>Going further ?</h3> 
    139 If you want more informations we strongly recommend you to read the <a href="../ref/Modulefiles.html">Module files documentation</a></textarea> 
     139If you want more information we strongly recommend you to read the <a href="../ref/Modulefiles.html">Module files documentation</a></textarea> 
    140140<script type="text/javascript">xooki.postProcess();</script> 
    141141</body> 

  • trunk/src/documentation/howto/writePlugins.html

    r354 r392  
    145145<ul> 
    146146<li>phases on which it relies</li> 
    147 <li>parameters (properties, resource collections, paths), with for each if it is required or not, default value.</li> 
     147<li>parameters (properties, resource collections, paths).  For each parameter specify name, description, whether it is required, and optionally a default value.</li> 
    148148<li>expected environment (files in a directory, a server up and running, ...)</li> 
    149149<li>results produced</li> 
    … …  
    198198<h3>Adding additional files to your module</h3> 
    199199Sometimes, we need to have a .properties files related to a given plugin. 
    200 Sometimes it could be an additional file (Example a .xsl file for example). 
     200Sometimes it could be an additional file (an .xsl file for example). 
    201201 
    202202Before using it we must declare the new file in the plugin module descriptor. 
    … …  
    223223</ivy-module> 
    224224</code> 
    225 Here we defined that our plugin is composed by 3 files : 
     225Here we defined that our plugin is composed of 3 files : 
    226226<ul> 
    227227<li>myplugin.ant (if name argument is not specified the module name will be used)</li> 
    … …  
    231231 
    232232Now we will see how we can use those files in our plugin script. 
    233 Considering that a plugin must be generic and can be retrieved from different repository (filesystem, url, ftp, etc...) we should take care of how we reference those additional file in our script. 
     233Considering that a plugin must be generic and can be retrieved from different repository (filesystem, url, ftp, etc...) we should take care of how we reference those additional files in our script. 
    234234To avoid any problems due to repository layout configuration, easyant gives you gives you access to properties containing the absolute path of a declared artifact. Those properties are composed with the following syntax : 
    235235<code type="xml"> 
    … …  
    241241</code> 
    242242 
    243 The '.artifact' is optionnal when module name and artifact name are the same.  
     243The '.artifact' is optional when module name and artifact name are the same.  
    244244<code type="xml"> 
    245245[organisation].[module].[type].file 
    … …  
    287287</ivy-module> 
    288288</code> 
    289 Here we depends on amazingAntTask and myOtherAntTask provided by foobar organisation. 
     289Here we depend on amazingAntTask and myOtherAntTask provided by foobar organisation. 
    290290<h4>Using dependency in your plugin ant script?</h4> 
    291 Easyant automatically creates a classpath specific for each plugins, this classpath contains all the <i>.jars</i> contained in dependencies. 
    292  
    293 The name of the classpath is named  
     291Easyant automatically creates a classpath specific for each plugin, this classpath contains all the required dependency <i>.jars</i>. 
     292 
     293The classpath is named  
    294294<code tyep="xml"> 
    295295[organisation]#[module].classpath 
    … …  
    354354        <import file="../../main/resources/myplugin.ant"/> 
    355355         
    356         <!-- Defines a setUp / tearDown (before each test) that cleans the environnement -->  
     356        <!-- Defines a setUp / tearDown (before each test) that cleans the environment -->  
    357357        <target name="clean" description="remove stale build artifacts before / after each test"> 
    358358                <delete dir="${basedir}" includeemptydirs="true"> 
    … …  
    373373</project>    
    374374</code> 
    375 Considering that our plugin relies to external phase (validate in our example) we must mock it in our test. 
     375Considering that our plugin relies on an externally defined phase (validate in our example) we must mock it in our test. 
    376376Then we : 
    377377<ul> 
    … …  
    381381</ul> 
    382382 
    383 All target prefixed by "test" will be executed as a test case (similar to junit 3 behavior). 
     383All targets prefixed by "test" will be executed as a test case (similar to junit 3 behavior). 
    384384 
    385385Now we will write a test case for our ":helloworld" target. 
    … …  
    391391</code> 
    392392 
    393 Test can be executed when running : 
     393Tests can be executed by running : 
    394394<code type="shell">> easyant test</code> 
    395395 

  • trunk/src/documentation/index.html

    r390 r392  
    3535If you are browsing this documentation from your installation of EasyAnt, you can also check the <a href="http://www.easyant.org/doc/">online version</a> for latest updates. 
    3636 
    37 You can also browse this documentation offline either by downloading the documentation distribution, or by checking out the src/documentation directory from svn. This documentation uses xooki as documentation engine, so you can very easily edit it and submit patches? when you browse it from source.</textarea> 
     37You can also browse this documentation offline either by downloading the documentation distribution, or by checking out the src/documentation directory from svn. This documentation uses xooki as documentation engine, so you can very easily edit it and submit patches when you browse it from source.</textarea> 
    3838<script type="text/javascript">xooki.postProcess();</script> 
    3939</body>