maven-plugins/xdoc/xdocs/faq.fml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!-- 
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 -->

<faqs title="Frequently Asked Questions">

  <part id="general">
    <title>General</title>

    <faq id="classic-theme">
      <question>How can I get the "classic" (Maven 1.0 RC1 and below) theme on my site?</question>
      <answer>
        You can switch to the classic CSS by setting
        <source>maven.xdoc.theme=classic</source>
      </answer>
    </faq>
   
    <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;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>
    <faq id="i18n">
      <question>Does the documentation generated by Maven Xdocs plugin support internationalization?</question>
      <answer>
        Yes. Please see the <a href="reference/i18n.html">i18n</a> document.
      </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>&lt;menu name="Menu Name"&gt;</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>
&lt;item name="The Site" href="http://www.thesite.net/" img="http://www.thesite.net/thesite.png"/&gt;
        </source>
      </answer>
    </faq>

    <faq id="navigation-collapse">
      <question>How do I create collapsible items?</question>
      <answer>
        Add a collapse="true" attribute, e.g.
        <source>
&lt;item name="Design" href="/design.html" collapse="true"&gt;
        </source>
      </answer>
    </faq>

    <faq id="navigation-google">
      <question>How do I add the Google search to my pages?</question>
      <answer>
        Add a &lt;search/&gt; element to your navigation.xml file. e.g:
        <source>
&lt;project name="foo"&gt;
  &lt;body&gt; 
    &lt;menu name="bar"&gt;
       ..   
    &lt;/menu&gt;
 
    &lt;search/&gt;
&lt;/project&gt;
        </source>
      </answer>
    </faq>
  </part>

  <part id="problems">
    <title>Specific problems</title>

    <faq id="problems-unicode">
      <question>Can I use Unicode characters in my xml files?</question>
      <answer>
        Yes. You will have to set you system locale accordingly when
        you generate a site, <em>eg.</em> on Linux:
        '<code>export LANG=en_US.UTF-8</code>'.
      </answer>
    </faq>

  </part>


  <!--
    <faq id="">
      <question></question>
      <answer>
      </answer>
    </faq>
  -->
</faqs>