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
This commit is contained in:
dion committed
1 parent
adeae6bdc2
commit
99eadfce86
4 files changed
+140
-1
No files matched your search
@@ -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
|
||||
@@ -124,4 +124,20 @@
|
||||
<version>1.0.b2</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
<reports>
|
||||
<report>maven-jdepend-plugin</report>
|
||||
<report>maven-checkstyle-plugin</report>
|
||||
<report>maven-changes-plugin</report>
|
||||
<report>maven-changelog-plugin</report>
|
||||
<report>maven-findbugs-plugin</report>
|
||||
<report>maven-file-activity-plugin</report>
|
||||
<report>maven-developer-activity-plugin</report>
|
||||
<report>maven-javadoc-plugin</report>
|
||||
<report>maven-jxr-plugin</report>
|
||||
<report>maven-junit-report-plugin</report>
|
||||
<report>maven-tasklist-plugin</report>
|
||||
<report>maven-pmd-plugin</report>
|
||||
<report>maven-simian-plugin</report>
|
||||
<report>maven-faq-plugin</report>
|
||||
</reports>
|
||||
</project>
|
||||
@@ -0,0 +1,122 @@
|
||||
<?xml version="1.0" encoding="ISO-8859-1"?>
|
||||
<faqs title="Frequently Asked Questions">
|
||||
|
||||
<part id="general">
|
||||
<title>General</title>
|
||||
|
||||
<faq id="footer-company">
|
||||
<question>
|
||||
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?
|
||||
</question>
|
||||
<answer>Not at the moment</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="footer-position">
|
||||
<question>
|
||||
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?
|
||||
</question>
|
||||
<answer>Not at the moment</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="powered-by">
|
||||
<question>How can I change the powered by logo?</question>
|
||||
<answer>
|
||||
<source>
|
||||
# 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/
|
||||
</source>
|
||||
</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="description-html">
|
||||
<question>How do I put HTML in my description?</question>
|
||||
<answer>Use html escape notion. e.g: &amp;gt;</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="own-index">
|
||||
<question>
|
||||
Can I create my own index page rather than using the
|
||||
autogenerated page from the description?
|
||||
</question>
|
||||
<answer>Create an index.xml file in the xdocs directory.</answer>
|
||||
</faq>
|
||||
</part>
|
||||
|
||||
<part id="navigation">
|
||||
<title>Navigation</title>
|
||||
|
||||
<faq id="navigation-add-menu">
|
||||
<question>
|
||||
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) ?
|
||||
</question>
|
||||
<answer>
|
||||
To add a new menu, use the
|
||||
<source><menu name="Menu Name"></source> element.
|
||||
Each linkable entry underneath is its own item.
|
||||
</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="navigation-move-project-info">
|
||||
<question>
|
||||
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?
|
||||
</question>
|
||||
<answer>Not at the moment</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="navigation-images">
|
||||
<question>How can I add images to the navigation?</question>
|
||||
<answer>
|
||||
Add an img attribute to the item element.
|
||||
<source>
|
||||
<item name="The Site" href="http://www.thesite.net/" img="http://www.thesite.net/thesite.png"/>
|
||||
</source>
|
||||
</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="navigation-collapse">
|
||||
<question>How do I create collapsible items?</question>
|
||||
<answer>
|
||||
Add a collapse="true" attribute, e.g.
|
||||
<source>
|
||||
<item name="Design" href="/design.html" collapse="true">
|
||||
</source>
|
||||
</answer>
|
||||
</faq>
|
||||
|
||||
<faq id="navigation-google">
|
||||
<question>How do I add the Google search to my pages?</question>
|
||||
<answer>
|
||||
Add a <search/> element to your navigation.xml file. e.g:
|
||||
<source>
|
||||
<project name="foo">
|
||||
<body>
|
||||
<menu name="bar">
|
||||
..
|
||||
</menu>
|
||||
|
||||
<search/>
|
||||
</project>
|
||||
</source>
|
||||
</answer>
|
||||
</faq>
|
||||
</part>
|
||||
|
||||
<!--
|
||||
<faq id="">
|
||||
<question></question>
|
||||
<answer>
|
||||
</answer>
|
||||
</faq>
|
||||
-->
|
||||
</faqs>
|
||||
|
||||
@@ -11,6 +11,7 @@
|
||||
<item name="Goals" href="/goals.html"/>
|
||||
<item name="Properties" href="/properties.html"/>
|
||||
<item name="Changes report" href="/changes-report.html"/>
|
||||
<item name="FAQs" href="/faq.html"/>
|
||||
</menu>
|
||||
</body>
|
||||
</project>
|
||||
Reference in new issue
Block a user