doxia-test-docs/src/main/resources/doxia-site/fml/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">
    <faq id="How_to_handle_style_in_the_APT_markup_language">
      <question>How to handle style in the APT markup language?</question>
      <answer>
        <p>
          APT doesn't currently support style. It is in the roadmap.
        </p>
      </answer>
    </faq>
    <faq id="How_to_export_in_PDF">
      <question>How to export in PDF?</question>
      <answer>
        <p>
          There are two modules available that can be used to generate pdf output: an
          <a href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-itext/">iText module</a>
          that uses the
          <a href="http://www.lowagie.com/iText/">iText</a> framework, and a
          <a href="http://maven.apache.org/doxia/doxia/doxia-modules/doxia-module-fo/">FO</a> module,
          that can be used e.g. in conjunction with
          <a href="http://xmlgraphics.apache.org/fop/">Apache FOP</a> to generate a pdf.
          Unfortunately, the iText team has discontinued the XML to PDF functionalities, so probably
          only the fo module is going to be supported in the future.
        </p>
        <p>
          A pdf plugin for m2 is currently in development in the Doxia sandbox. You can get the source
          <a href="http://svn.apache.org/repos/asf/maven/sandbox/trunk/plugins/maven-pdf-plugin/">here</a>.
        </p>
      </answer>
    </faq>
    <faq id="Is_it_possible_to_create_a_book">
      <question>Is it possible to create a book?</question>
      <answer>
        <p>
          Doxia also has a fairly simple tool for writing books. It comes complete with a Maven plugin
          to produce PDFs, LaTeX documents and Xdoc for direct integration in your Maven site.
          The <a href="http://svn.apache.org/repos/asf/maven/doxia/doxia-tools/trunk/doxia-book-renderer/">Doxia Book code</a>
          is still limited but fully functional.
        </p>
      </answer>
    </faq>
    <faq id="Why XML based sinks don't generate nicely formatted documents">
      <question>Why XML based sinks don't generate nicely formatted documents?</question>
      <answer>
        <p>
          We decided to keep pretty printing out of the core modules. So, XML based sinks like Xdoc or XHTML are
          intentionally unformatted. You could always do this after the document generation or directly
          by creating a specialized end-user sink (see <a href="http://jira.codehaus.org/browse/DOXIA-255">DOXIA-255</a>).
        </p>
      </answer>
    </faq>
    <!-- TODO need to publish XSD files -->
    <faq id="doxia-xsd">
      <question>Where are the Maven Doxia XSD schemas for Xdoc and FML files?</question>
      <answer>
        <p>
          The Xdoc XSD is located <a href="https://maven.apache.org/xsd/xdoc-2.0.xsd">here</a> and
          the FML XSD is located <a href="https://maven.apache.org/xsd/fml-1.0.1.xsd">here</a>.
        </p>
        <p>
          Your favorite IDE probably supports XSD schema's for Xdoc and FML files. You need to
          specify the following:
        <source>
&lt;document xmlns="http://maven.apache.org/XDOC/2.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 https://maven.apache.org/xsd/xdoc-2.0.xsd"&gt;
  ...
&lt;/document&gt;</source>
        <source>
&lt;faqs xmlns="http://maven.apache.org/FML/1.0.1"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 https://maven.apache.org/xsd/fml-1.0.1.xsd"&gt;
  ...
&lt;/faqs&gt;</source>
        </p>
      </answer>
    </faq>
  </part>
</faqs>