hc-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject svn commit: r1069055 - /httpcomponents/project/src/site/apt/dev-docs.apt
Date Wed, 09 Feb 2011 19:46:01 GMT
Author: sebb
Date: Wed Feb  9 19:46:01 2011
New Revision: 1069055

URL: http://svn.apache.org/viewvc?rev=1069055&view=rev
Log:
Describe Maven skin; add a link to the APT format

Modified:
    httpcomponents/project/src/site/apt/dev-docs.apt

Modified: httpcomponents/project/src/site/apt/dev-docs.apt
URL: http://svn.apache.org/viewvc/httpcomponents/project/src/site/apt/dev-docs.apt?rev=1069055&r1=1069054&r2=1069055&view=diff
==============================================================================
--- httpcomponents/project/src/site/apt/dev-docs.apt (original)
+++ httpcomponents/project/src/site/apt/dev-docs.apt Wed Feb  9 19:46:01 2011
@@ -49,3 +49,49 @@ Web Site Updates
    Instructions for updating the various sections of our website are
    {{{http://wiki.apache.org/HttpComponents/WebSite}
      in the Wiki}}.
+
+Maven Skin details
+
+   The HC project has created a Maven skin to enable customisation of page footers.
+   This is intended to be used to add Trademark notices to pages. 
+
+   To use the skin, add the following to the <<<src/site/site.xml>>> file:
+
++-------------------------------------------
+<project ...
+
+  <skin>
+    <groupId>org.apache.httpcomponents</groupId>
+    <artifactId>maven-site-skin</artifactId>
+    <version>1.0</version>
+  </skin>
++-------------------------------------------
+
+   The skin contains an updated version of the default Maven template. The template
+   checks the site.xml file for the presence of the following custom tag:
+
++-------------------------------------------
+   <custom>
+      <footer>
+      Optional HTML-formatted text goes here
+      </footer>
+   </custom>
++--------------------------------------------
+
+   If the tag is found, its contents are added to the footer just before the copyright statement.
+   Example usage:
+   
++--------------------------------------------
+ <custom>
+    <footer>
+      <div class="xleft">Apache HttpComponents, Commons HttpClient, Apache, the Apache
feather logo, 
+      and the Apache HttpComponents project logo are trademarks of The Apache Software Foundation.</div>
+      <br/>
+      <div class="xleft">All other marks mentioned may be trademarks or registered
trademarks of their respective owners.</div>
+    </footer>
+  </custom>
++--------------------------------------------
+
+Editting APT documents
+
+   The APT syntax is documented at {{http://maven.apache.org/doxia/references/apt-format.html}}
\ No newline at end of file



Mime
View raw message