Merge pull request #43 from Bernardo-MG/merge_master

Merge master
Bernardo-MG · Jul 31, 2016 · 0f8a02f · 0f8a02f
2 parents b00a235 + 00455e5
commit 0f8a02f
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -48,7 +48,9 @@ The verify phase is required, as otherwise some of the reports won't be created.
 
 ## Usage
 
-The application is coded in Velocity Template Language, using Maven to manage the project.
+The project is coded in Velocity Template Language, using Maven to manage the project.
+
+It also requires Maven to be used, being set up as a Maven Skin for the Maven Site of any other Maven-based project.
 
 ### Prerequisites
 
@@ -70,6 +72,20 @@ If for some reason manual installation is necessary, just use the following Mave
 $ mvn install
 ```
 
+### Setting up the skin
+
+To use the Skin when generating a Maven Site just add the following to the site.xml file:
+
+```xml
+<skin>
+    <groupId>com.wandrell.maven</groupId>
+    <artifactId>docs-maven-skin</artifactId>
+    <version>[current version]</version>
+</skin>
+```
+
+More detailed information can be found in the documentation (check the links in the documentation section earlier in this file).
+
 ## Collaborate
 
 Any kind of help with the project will be well received, and there are two main ways to give such help:

diff --git a/pom.xml b/pom.xml
@@ -20,8 +20,7 @@
 
    <groupId>com.wandrell.maven.skins</groupId>
    <artifactId>docs-maven-skin</artifactId>
-   <version>0.3.1</version>
-   <packaging>jar</packaging>
+   <version>0.3.2</version>
 
    <name>Docs Maven Skin</name>
    <description>A Maven skin for using Maven Site as a documentation site</description>

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -123,5 +123,10 @@
             maven site.
          </action>
       </release>
+      <release version="0.3.2" date="2015-07-31" description="Improved usage info">
+         <action dev="bmg" type="fix">
+            The readme and docs now state more clearly how to use the skin.
+         </action>
+      </release>
    </body>
 </document>
diff --git a/src/site/markdown/usage.md → src/site/markdown/usage.md.vm b/src/site/markdown/usage.md → src/site/markdown/usage.md.vm
@@ -1,18 +1,17 @@
-#Usage
+#set( $symbol_pound = '#' )
+${symbol_pound} Usage
 
-Once the dependencies have been set, the skin can be used by adding the following element to the site.xml file:
+[Once the dependencies have been set][acquire], the skin can be used by adding the following element to the site.xml file:
 
 ```xml
 <skin>
     <groupId>com.wandrell.maven</groupId>
     <artifactId>docs-maven-skin</artifactId>
-    <version>${site.skin.version}</version>
+    <version>${project.version}</version>
 </skin>
 ```
 
-As shown, it is recommended defining the version in the properties section of the POM, which will then be replaced by Maven automatically before creating the site.
-
-## Sample site.xml
+${symbol_pound}${symbol_pound} Sample site.xml
 
 The site requires a correctly configured site.xml file to work. For more details check the [site.xml page][site_xml], but the following shows an example of how it should look:
 
@@ -25,7 +24,7 @@ The site requires a correctly configured site.xml file to work. For more details
     <skin>
         <groupId>com.wandrell.maven</groupId>
         <artifactId>docs-maven-skin</artifactId>
-        <version>${site.skin.version}</version>
+        <version>${project.version}</version>
     </skin>
 
     <custom>
@@ -55,14 +54,6 @@ The site requires a correctly configured site.xml file to work. For more details
             <bottomNav>
                 <menu>General Info</menu>
             </bottomNav>
-            <pages>
-                <index>
-                    <sections>
-                        <body />
-                        <columns>2</columns>
-                    </sections>
-                </index>
-            </pages>
         </skinConfig>
     </custom>
 
@@ -85,6 +76,7 @@ The site requires a correctly configured site.xml file to work. For more details
 </project>
 ```
 
-Note that this example site.xml shown includes some properties which are read from the POM file, such as *${bintrayURL}*.
+Note that while this example site.xml shows a working file, it is recommended taking advantage of Maven's variable substitution for setting up things such as the skin version or the external URLs.
 
+[acquire]: ./acquire.html
 [site_xml]: ./site_xml.html