Bommels05/maven-plugins
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix some xhtml warnings/errors

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@289581 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
aheritier 2005-09-16 15:22:36 +00:00
parent 9e6a196933
commit 9f6d56c75f
4 changed files with 20 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
changes/src/plugin-resources/changes.jsl
View File

@ -58,7 +58,7 @@
<j:set var="date"><x:expr select="@date"/></j:set> <j:set var="date"><x:expr select="@date"/></j:set>
<j:set var="description"><x:expr select="@description"/></j:set> <j:set var="description"><x:expr select="@description"/></j:set>
<j:set var="anchorName"><doc:escapeNameToken value="${version}"/></j:set> <j:set var="anchorName"><doc:escapeNameToken value="${version}"/></j:set>
<td><a href="#${anchorName}">${version}</a></td> <td><a href="#Release${anchorName}">${version}</a></td>
<td>${date}</td> <td>${date}</td>
<td>${description}</td> <td>${description}</td>
</tr> </tr>
@ -76,7 +76,7 @@
<j:set var="version"><x:expr select="@version"/></j:set> <j:set var="version"><x:expr select="@version"/></j:set>
<section name="${sectionName}"> <section name="${sectionName}">
<j:set var="anchorName"><doc:escapeNameToken value="${version}"/></j:set> <j:set var="anchorName"><doc:escapeNameToken value="${version}"/></j:set>
<a name="${anchorName}"/> <a id="Release${anchorName}" name="Release${anchorName}"/>
<table> <table>
<tr><th style='width:50px'>Type</th><th>Changes</th><th style='width:70px'>By</th></tr> <tr><th style='width:50px'>Type</th><th>Changes</th><th style='width:70px'>By</th></tr>
<j:choose> <j:choose>

1
changes/xdocs/changes.xml
View File

@ -25,6 +25,7 @@
</properties> </properties>
<body> <body>
<release version="1.6-SNAPSHOT" date="in SVN"> <release version="1.6-SNAPSHOT" date="in SVN">
<action dev="aheritier" type="fix">Fix XTHML 1.0 compliance.</action>
<action dev="ltheussl" type="fix" issue="MPCHANGES-22" due-to="Mike Traum">Document description attribute of release element.</action> <action dev="ltheussl" type="fix" issue="MPCHANGES-22" due-to="Mike Traum">Document description attribute of release element.</action>
<action dev="brett" type="add">Add a live bookmark link for the RSS for Firefox.</action> <action dev="brett" type="add">Add a live bookmark link for the RSS for Firefox.</action>
<action dev="vmassol" type="fix" issue="MPCHANGES-14"> <action dev="vmassol" type="fix" issue="MPCHANGES-14">

2
xdoc/xdocs/faq.fml
View File

@ -150,7 +150,7 @@ maven.xdoc.poweredby.url = http://maven.apache.org/
<question>Can I use Unicode characters in my xml files?</question> <question>Can I use Unicode characters in my xml files?</question>
<answer> <answer>
Yes. You will have to set you system locale accordingly when Yes. You will have to set you system locale accordingly when
you generate a site, <emph>eg.</emph> on Linux: you generate a site, <em>eg.</em> on Linux:
'<code>export LANG=en_US.UTF-8</code>'. '<code>export LANG=en_US.UTF-8</code>'.
</answer> </answer>
</faq> </faq>

56
xdoc/xdocs/index.xml
View File

@ -1,6 +1,6 @@
<?xml version="1.0"?> <?xml version="1.0"?>
<!DOCTYPE document [ <!DOCTYPE document [
<!ENTITY escapeXmlExample SYSTEM "file:xdocs/escapeXml.xml"> <!ENTITY escapeXmlExample SYSTEM "escapeXml.xml">
]> ]>
<!-- <!--
/* /*
@ -54,17 +54,12 @@
</footer>]]></source> </footer>]]></source>
</subsection> </subsection>
<subsection name="Navigation bar"> <subsection name="Navigation bar">
<p> <p>You can put a navigation bar on bottom of each page by including a <code>&lt;navbar/&gt;</code> element in an xdoc's body. This element takes three optional attributes, <code>prev</code>, <code>home</code> and <code>next</code>, as shown in the following example: </p>
You can put a navigation bar on bottom of each page by including
a <code>&lt;navbar/&gt;</code> element in an xdoc's body.
This element takes three optional attributes,
<code>prev</code>, <code>home</code> and <code>next</code>, as
shown in the following example:
</p>
<source><![CDATA[<navbar prev="first.html" home="../index.html" next="next.html"/>]]></source> <source><![CDATA[<navbar prev="first.html" home="../index.html" next="next.html"/>]]></source>
</subsection> </subsection>
<subsection name="Google Search"> <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> <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>
<subsection name="escapeXml Tag"> <subsection name="escapeXml Tag">
<p>If you need to include the contents of another XML document in your document, you can use the <code>&lt;escapeXml&gt;</code> tag, as demonstrated below. For instance, the code:</p> <p>If you need to include the contents of another XML document in your document, you can use the <code>&lt;escapeXml&gt;</code> tag, as demonstrated below. For instance, the code:</p>
@ -79,51 +74,26 @@
</source> </source>
</subsection> </subsection>
<subsection name="Open Link in New Window"> <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> <p>To open a link in a new window, use the "target" attribute. For example, for a menu item: </p>
<source><![CDATA[<item name="Name" href="URL" target="_blank"/>]]></source>
<p>XDoc automatically adds the "Opens in a new window" icon and "New Window" tooltip to links with the "target" attribute.</p>
</subsection> </subsection>
<subsection name="External Link Icon"> <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> <p>XDoc automatically adds the "External Link" icon and tooltip to links referring to external sites (actually, any absolute url).</p>
</subsection> </subsection>
<subsection name="Referencing sections and subsections"> <subsection name="Referencing sections and subsections">
<p> <p>From version <code>1.10</code> on, the <code>xdoc</code> plugin allows for an optional <code>id</code> tag in the <code>section</code> and <code>subsection</code> elements: </p>
From version <code>1.10</code> on, the <code>xdoc</code> plugin
allows for an optional <code>id</code> tag in the <code>section</code>
and <code>subsection</code> elements:
</p>
<source><![CDATA[<section name="Section" id="Section1"> <source><![CDATA[<section name="Section" id="Section1">
<subsection name="SubSection" id="SubSection1"> <subsection name="SubSection" id="SubSection1">
</subsection> </subsection>
</section>]]></source> </section>]]></source>
<p> <p>An anchor is constructed from each <code>id</code> tag, so you can reference sections and subsections from other source documents. Note that each <code>id</code> tag has to be unique within one source document.</p>
An anchor is constructed from each <code>id</code> tag, <p>In previous versions of the plugin, an <code>id</code> tag was constructed from section/subsection names, replacing special characters by underscores. For backwards compatibility reasons, we keep this behaviour, <em>i.e.</em>, if no <code>id</code> tag is present, an anchor is constructed from the <code>name</code> tag. Note that this presents two shortcomings:</p>
so you can reference sections and subsections from other source
documents. Note that each <code>id</code> tag has to be unique
within one source document.
</p>
<p>
In previous versions of the plugin, an <code>id</code> tag
was constructed from section/subsection names, replacing special
characters by underscores. For backwards compatibility reasons,
we keep this behaviour, <emph>i.e.</emph>, if no <code>id</code> tag
is present, an anchor is constructed from the <code>name</code> tag.
Note that this presents two shortcomings:
</p>
<ul> <ul>
<li> <li>If two sections or subsections have identical names (within one source document), you will get an ambiguity when referencing them. Also the resulting html document will not be valid XHTML.</li>
If two sections or subsections have identical names <li>For long section titles, this leads to rather cumbersome anchor names.</li>
(within one source document), you will get an ambiguity when
referencing them. Also the resulting html document will not be
valid XHTML.
</li>
<li>
For long section titles, this leads to rather
cumbersome anchor names.
</li>
</ul> </ul>
<p> <p>We recommend that you provide an <code>id</code> tag if you want to reference a section or subsection.</p>
We recommend that you provide an <code>id</code> tag if you
want to reference a section or subsection.
</p>
</subsection> </subsection>
</section> </section>
</body> </body>