From 99eadfce86c1a8c935be560f159540b4a9f827ae Mon Sep 17 00:00:00 2001 From: dion Date: Sun, 7 Sep 2003 14:50:33 +0000 Subject: [PATCH] Move xdoc FAQs from Wiki to site docs git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@113968 13f79535-47bb-0310-9956-ffa450edef68 --- xdoc/project.properties | 2 +- xdoc/project.xml | 16 +++++ xdoc/xdocs/faq.fml | 122 ++++++++++++++++++++++++++++++++++++++ xdoc/xdocs/navigation.xml | 1 + 4 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 xdoc/xdocs/faq.fml diff --git a/xdoc/project.properties b/xdoc/project.properties index c093b8bd..7642cd98 100644 --- a/xdoc/project.properties +++ b/xdoc/project.properties @@ -5,4 +5,4 @@ maven.xdoc.date=left maven.xdoc.version=${pom.currentVersion} #maven.xdoc.developmentProcessUrl=http://maven.apache.org/development-process.html maven.license.licenseFile=${basedir}/../../../LICENSE.txt - +maven.checkstyle.header.file=${basedir}/../../../LICENSE.txt diff --git a/xdoc/project.xml b/xdoc/project.xml index 19a20d5c..27c81373 100644 --- a/xdoc/project.xml +++ b/xdoc/project.xml @@ -124,4 +124,20 @@ 1.0.b2 + + maven-jdepend-plugin + maven-checkstyle-plugin + maven-changes-plugin + maven-changelog-plugin + maven-findbugs-plugin + maven-file-activity-plugin + maven-developer-activity-plugin + maven-javadoc-plugin + maven-jxr-plugin + maven-junit-report-plugin + maven-tasklist-plugin + maven-pmd-plugin + maven-simian-plugin + maven-faq-plugin + diff --git a/xdoc/xdocs/faq.fml b/xdoc/xdocs/faq.fml new file mode 100644 index 00000000..b912c669 --- /dev/null +++ b/xdoc/xdocs/faq.fml @@ -0,0 +1,122 @@ + + + + + General + + + + On the footer that Maven adds with the company name ... + is there any way I can make the company name a hyperlink to + copyright info for the company? + + Not at the moment + + + + + Can I specify to have the Maven footer (2002-2003 company name) + just below the line "Last Published ..." ? rather than + at the foot of the page ? What is the property entry for this? + + Not at the moment + + + + How can I change the powered by logo? + + +# The logo to show on the generated site. No default at present +maven.xdoc.poweredby.image = maven-bolt.png +maven.xdoc.poweredby.title = Bolted together with Maven +maven.xdoc.poweredby.url = http://maven.apache.org/ + + + + + + How do I put HTML in my description? + Use html escape notion. e.g: &amp;gt; + + + + + Can I create my own index page rather than using the + autogenerated page from the description? + + Create an index.xml file in the xdocs directory. + + + + + Navigation + + + + I've discovered the navigation.xml file and + can now add links and menu items. How do I add a menu 'header' + to navigation.xml in the same style as the generated + 'Project Documentation' header (which comes out in HTML within STRONG tags) ? + + + To add a new menu, use the + <menu name="Menu Name"> element. + Each linkable entry underneath is its own item. + + + + + + Is there any way I can specify whereabouts in the navigation.xml + Maven adds the 'Project Information' block or is it always at the foot? + + Not at the moment + + + + How can I add images to the navigation? + + Add an img attribute to the item element. + +<item name="The Site" href="http://www.thesite.net/" img="http://www.thesite.net/thesite.png"/> + + + + + + How do I create collapsible items? + + Add a collapse="true" attribute, e.g. + +<item name="Design" href="/design.html" collapse="true"> + + + + + + How do I add the Google search to my pages? + + Add a <search/> element to your navigation.xml file. e.g: + +<project name="foo"> + <body> + <menu name="bar"> + .. + </menu> + + <search/> +</project> + + + + + + + + \ No newline at end of file diff --git a/xdoc/xdocs/navigation.xml b/xdoc/xdocs/navigation.xml index 13614377..b9ea025b 100644 --- a/xdoc/xdocs/navigation.xml +++ b/xdoc/xdocs/navigation.xml @@ -11,6 +11,7 @@ +