Author: aheritier
Date: Sat Sep 3 16:33:49 2005
New Revision: 267517
URL: http://svn.apache.org/viewcvs?rev=267517&view=rev
Log:
MPXDOC-156 : Add documentation about "external links" and "new windows".
Patch submitted by : Jeff Jensen
Patch reviewed by : Arnaud Heritier
Modified:
maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
maven/maven-1/plugins/trunk/xdoc/xdocs/index.xml
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml?rev=267517&r1=267516&r2=267517&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/changes.xml Sat Sep 3 16:33:49 2005
@@ -26,6 +26,7 @@
</properties>
<body>
<release version="1.9.2-SNAPSHOT" date="In SVN">
+ <action dev="aheritier" type="fix" issue="MPXDOC-156" due-to="Jeff
Jensen">Add documentation about "external links" and "new windows".</action>
<action dev="aheritier" type="fix" issue="MPXDOC-155" due-to="Lukas
Theussl">Xdoc plugin >= 1.9 not compatible with older customised
site.jsl.</action>
<action dev="aheritier" type="fix" issue="MPXDOC-154" due-to="Juan F.
Codagnone,Vincent Siveton,Lukas Theussl">System locale setting makes test cases
fail.</action>
<action dev="vsiveton" type="fix" issue="MPXDOC-152" due-to="Arnaud
Heritier">cvs-usage link not shown in project-info page</action>
Modified: maven/maven-1/plugins/trunk/xdoc/xdocs/index.xml
URL:
http://svn.apache.org/viewcvs/maven/maven-1/plugins/trunk/xdoc/xdocs/index.xml?rev=267517&r1=267516&r2=267517&view=diff
==============================================================================
--- maven/maven-1/plugins/trunk/xdoc/xdocs/index.xml (original)
+++ maven/maven-1/plugins/trunk/xdoc/xdocs/index.xml Sat Sep 3 16:33:49 2005
@@ -2,16 +2,16 @@
<!DOCTYPE document [
<!ENTITY escapeXmlExample SYSTEM "file:xdocs/escapeXml.xml">
]>
-<!--
+<!--
/*
* Copyright 2001-2005 The Apache Software Foundation.
- *
+ *
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
- *
+ *
* http://www.apache.org/licenses/LICENSE-2.0
- *
+ *
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -19,80 +19,61 @@
* limitations under the License.
*/
-->
-
<document>
-
<properties>
<title>About</title>
<author email="[EMAIL PROTECTED]">Jason van Zyl</author>
</properties>
-
<body>
<section name="Maven XDoc Plug-in">
- <p>
- The Xdoc plugin is the primary mechanism used to produce the
- Maven-generated documentation as well as any user supplied
- "xdocs". An xdoc is an XML document conforming to a small and
- simple set of tags. Maven uses this format extensively. All
- Maven-generated reports are first generated as an xdoc, which
- is then transformed to HTML via this plugin.
- </p>
- <p>
- The documentation is mainly in <code>Anakia</code> format. More
- information along with samples, can be found at:
- </p>
- <ul>
- <li>
- <a href="http://jakarta.apache.org/site/jakarta-site-tags.html";>the
tags defined</a>
- </li>
- <li>
- <a
href="http://jakarta.apache.org/site/jakarta-site-tags-example.html";>examples
of the tags</a>
- </li>
- </ul>
- <p>
- There are a few additions to the anakia format. You can use the
- <code>footer</code> tag for including text or images just below
- the navigation menu and above the copyright notice. This tag is
- only usefull in the navigation.xml file and should be placed
- within the body element. For example:
- </p>
- <source><![CDATA[<!-- footer will be placed above the (c) -->
+ <subsection name="Overview">
+ <p>The Xdoc plugin is the primary mechanism used to produce the
Maven-generated documentation as well as any user supplied "xdocs". An xdoc is
an XML document conforming to a small and simple set of tags. Maven uses this
format extensively. All Maven-generated reports are first generated as an
xdoc, which is then transformed to HTML via this plugin.</p>
+ <p>The documentation is mainly in <code>Anakia</code> format. More
information along with samples, can be found at:
+ </p>
+ <ul>
+ <li>
+ <a
href="http://jakarta.apache.org/site/jakarta-site-tags.html";>the tags
defined</a>
+ </li>
+ <li>
+ <a
href="http://jakarta.apache.org/site/jakarta-site-tags-example.html";>examples
of the tags</a>
+ </li>
+ </ul>
+ <p>There are a few additions to the anakia format, highlighted in the
subsequent sections.</p>
+ </subsection>
+ <subsection name="Additional Files">
+ <p>In addition to xdocs, users may wish to include other types of files
such as images, their own HTML files, PDFs, etc. By default, this plugin will
copy all files located in the <code>maven.docs.src</code> directory
(<code>xdocs</code> by default) to the final generated site.</p>
+ <p>If you create a <code>style/project.css</code> stylesheet under
<code>maven.docs.src</code>, it will be copied to the resulting document tree
and imported into each page (via <code>@import</code>). This allows you to
easily add and modify the styles that are provided by Maven.</p>
+ </subsection>
+ <subsection name="Footer Tag">
+ <p>You can use the <code>footer</code> tag for including text or
images just below the navigation menu and above the copyright notice. This tag
is only usefull in the navigation.xml file and should be placed within the body
element. For example:</p>
+ <source><![CDATA[<!-- footer will be placed above the (c) -->
<footer>
<A href="http://sourceforge.net/projects/ctecl";>
<IMG src="http://sourceforge.net/sflogo.php?group_id=72748"; border="0"
alt="sf logo"/>
</A>
</footer>]]></source>
- <p>
- If a <code>search</code> element is found in the
<code>navigation.xml</code> body, a search navigation
- menu is generated that uses <a href="http://www.google.com";>google</a>
- </p>
- <p>
- In addition to xdocs, users may wish to include other types of
- files such as images, their own HTML files, PDFs, etc. By
- default, this plugin will copy all files located in the
- <code>maven.docs.src</code> directory (<code>xdocs</code> by
- default) to the final generated site.
- </p>
-
- <p>
- If you create a <code>style/project.css</code> stylesheet under
<code>maven.docs.src</code>,
- it will be copied to the resulting document tree and imported into
each page (via
- <code>@import</code>. This allows you to easily add and modify
- the styles that are provided by Maven.
- </p>
- <p>
- If you need to include the contents of another XML document in your
document, you can use the
- <code><escapeXml></code> tag, as demonstrated below. For
instance, the code:
- </p>
- <source><![CDATA[<?xml version="1.0"?>
+ </subsection>
+ <subsection name="Google Search">
+ <p>If a <code>search</code> element is found in the
<code>navigation.xml</code> body, a search navigation menu is generated that
uses <a href="http://www.google.com";>google</a></p>
+ </subsection>
+ <subsection name="escapeXml Tag">
+ <p>If you need to include the contents of another XML document in your
document, you can use the <code><escapeXml></code> tag, as demonstrated
below. For instance, the code:</p>
+ <source><![CDATA[<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY escapeXmlExample SYSTEM "file:xdocs/escapeXml.xml">
]>
-<escapeXml>&escapeXmlExample;</escapeXml>]]></source>
- <p>
- Would produce the following output (click <a
href="escapeXml.html">here</a> to see the content of
<code>escapeXml.xml</code>):
- </p>
- <source><escapeXml>&escapeXmlExample;</escapeXml></source>
+<escapeXml>&escapeXmlExample;</escapeXml>]]></source>
+ <p>Would produce the following output (click <a
href="escapeXml.html">here</a> to see the content of
<code>escapeXml.xml</code>):</p>
+ <source>
+ <escapeXml>&escapeXmlExample;</escapeXml>
+ </source>
+ </subsection>
+ <subsection name="Open Link in New Window">
+ <p>To open a link in a new window, use the "target" attribute. For
example, for a menu item: <source><![CDATA[<item name="Name" href="URL"
target="_blank"/>]]></source> XDoc automatically adds the "Opens in a new
window" icon and "New Window" tooltip to links with the "target" attribute.</p>
+ </subsection>
+ <subsection name="External Link Icon">
+ <p>XDoc automatically adds the "External Link" icon and tooltip to
links referring to external sites (actually, any absolute url).</p>
+ </subsection>
</section>
- </body>
+ </body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
