Skip to Content
Maven: A Developer's Notebook
book

Maven: A Developer's Notebook

by Vincent Massol, Timothy M. O'Brien
June 2005
Beginner
224 pages
5h 40m
English
O'Reilly Media, Inc.
Content preview from Maven: A Developer's Notebook

Using the FAQ Plug-in

Many projects contain pages full of frequently asked questions, which provide insight to everything from the reason why a particular project was started to how one can fix common technical problems. The Maven FAQ plug-in is a useful tool for creating such a page.

How do I do that?

To use the FAQ plug-in, list the plug-in in your project.xml reports element as follows:

<reports>
  <report>maven-faq-plugin</report>
</reports>

Now that you have the report activated, create the xdocs/faq.fml file with the following content:

Note

The reports element is not additive. If you specify only one report in this element, only one report is generated. You'll need to list all the reports you want explicitly in the reports element.

<?xml version="1.0" encoding="UTF-8"?> <faqs title="Frequently Asked Questions"> <part id="general"> <title>General</title> <faq id="whats-weather"> <question> What is the Weather project? </question> <answer> <p> The Weather project is an example from the Maven Developer's Notebook. It is an attempt to demonstrate simple Maven customization techniques with a project that isn't going to bore the reader to death. </p> </answer> </faq> <faq id="why-axis"> <question> Why did you choose the Axis plug-in? </question> <answer> <p> The Axis plug-in was selected because it happens to be a useful and complex tool that is easy to introduce. </p> </answer> </faq> </part> <part id="install"> <title>Installation</title> <faq id="how-install"> <question> How do I install ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Maven Crash Course

Maven Crash Course

Jason Taylor

Publisher Resources

ISBN: 0596007507Errata Page