You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-commits@maven.apache.org by sv...@apache.org on 2020/04/15 22:39:51 UTC
svn commit: r1876573 - in /maven/website/content:
guides/development/guide-documentation-style.html maven-site-1.0-site.jar
Author: svn-site-role
Date: Wed Apr 15 22:39:51 2020
New Revision: 1876573
Log:
Site checkin for project Apache Maven Site
Modified:
maven/website/content/guides/development/guide-documentation-style.html
maven/website/content/maven-site-1.0-site.jar
Modified: maven/website/content/guides/development/guide-documentation-style.html
==============================================================================
--- maven/website/content/guides/development/guide-documentation-style.html (original)
+++ maven/website/content/guides/development/guide-documentation-style.html Wed Apr 15 22:39:51 2020
@@ -146,8 +146,8 @@
<li><a class="externalLink" href="http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=26780">ISO-8601</a></li>
<li><a class="externalLink" href="http://en.wikipedia.org/wiki/ISO_8601">Wikipedia</a></li></ul></section></section><section>
<h3><a name="POM_Snippet"></a>POM Snippet</h3>
-<p>A POM file must use 2 spaces for each indentation. Because POM snippets are often used in documentation to show the user how to configure something, it is important that these snippets aren't too wide. If the are too wide it will make the page difficult to read on a smaller screen.</p>
-<p>When you use a snippet of XML from the POM as an example in your documentation, you need to make sure that the example is properly indented. A user should be able to copy and paste the example into their own POM without the need to change the indentation afterwards.</p>
+<p>A POM file must use 2 spaces for each indentation. Because POM snippets are often used in documentation to show the user how to configure something, it is important that these snippets aren't too wide. If they are too wide, the page is difficult to read on a smaller screen.</p>
+<p>When you use a snippet of XML from the POM as an example in documentation, make sure that the example is properly indented. A user should be able to copy and paste the example into their own POM without changing the indentation.</p>
<p>Also, you should declare all parent POM elements to improve the comprehension. You could use ellipsis (i.e. ...) if you don't want to specify elements.</p><section>
<h4><a name="Example"></a>Example</h4>
<p>The following is an example of how the distribution management of the Maven site is configured.</p>
@@ -161,17 +161,16 @@
</distributionManagement>
...
</project></pre></div>
-<p>As you can see above the <code><distributionManagement></code> element is indented once (=2 spaces), the <code><site></code> element in indented twice (=4 spaces) and the <code><id></code> is indented three times (=6 spaces).</p></section></section><section>
+<p>As you can see above the <code><distributionManagement></code> element is indented once (=2 spaces), the <code><site></code> element is indented twice (=4 spaces), and the <code><id></code> is indented three times (=6 spaces).</p></section></section><section>
<h3><a name="Naming_Documentation_Files"></a>Naming Documentation Files</h3>
-<p>All file names should replace space by a minus (-), for instance for this given APT document:</p>
+<p>All file names should replace space by a hyphen (-), for instance for this given APT document:</p>
<div class="source"><pre class="prettyprint linenums"> guide-documentation-style.apt</pre></div></section><section>
<h3><a name="Updating_Documentation_Files"></a>Updating Documentation Files</h3>
<p>A good practice is to update the date (with the correct date format) when you are updating documentation files.</p></section><section>
<h3><a name="Write_Thinking"></a>Write Thinking</h3>
<p>Here are some pointers about English rules when typing material:</p>
<ul>
-<li><a class="externalLink" href="http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style">Wikipedia:Manual of Style</a>, specifically <a class="externalLink" href="http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation">Punctuation Part</a></li>
-<li><a class="externalLink" href="http://developer.gnome.org/projects/gtp/style-guides/pdf/styleguide-C.pdf">Linguistic Style Guidelines</a>, specifically the "Grammatical Guidelines" chapter.</li></ul></section></section>
+<li><a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style">Wikipedia:Manual of Style</a>, specifically <a class="externalLink" href="https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Punctuation">Punctuation Part</a></li></ul></section></section>
</main>
</div>
</div>
Modified: maven/website/content/maven-site-1.0-site.jar
==============================================================================
Binary files - no diff available.