Maven 1.x FAQ Plugin

Multiple *.fml files for input to faq-plugin

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Fixed
  • Affects Version/s: None
  • Fix Version/s: None
  • Component/s: None
  • Labels:
    None
  • Number of attachments :
    2

Description

Would be nice if the faq-plugin could take more than one input file. Seems like the "maven.faq.src.file" property only allows us to mention one file.

But projects might very well have more than one FAQ.

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
dion gillard added a comment -

This would be nice. Got a patch?

Show
dion gillard added a comment - This would be nice. Got a patch?
Hide
Permalink
Per Olesen added a comment -

>This would be nice. Got a patch?

well, ... no i didn't, ... but know I do
figured I could give it a go and might learn some jelly on the way.

So I've made a patch, which extends faq to handle multiple input files. Generally, it works by using two properties:

<---

  1. Where source *.fml files are looked for
    maven.faq.src=${basedir}/xdocs
  1. Destination directory where output xdocs file are produced
    maven.faq.dest=${maven.build.dir}/generated-xdocs
    <---

It will also map the directory structure from source into target.

I will be attaching the patch, and hope someone will apply it.

BTW: I've not changed the docs for it yet. Want to see if someone thinks it is good enough for commit - then I'll be happy to update the docs !!

okay?

Show
Per Olesen added a comment - >This would be nice. Got a patch? well, ... no i didn't, ... but know I do figured I could give it a go and might learn some jelly on the way. So I've made a patch, which extends faq to handle multiple input files. Generally, it works by using two properties: <---
  1. Where source *.fml files are looked for maven.faq.src=${basedir}/xdocs
  1. Destination directory where output xdocs file are produced maven.faq.dest=${maven.build.dir}/generated-xdocs <---
It will also map the directory structure from source into target. I will be attaching the patch, and hope someone will apply it. BTW: I've not changed the docs for it yet. Want to see if someone thinks it is good enough for commit - then I'll be happy to update the docs !! okay?
Hide
Permalink
Per Olesen added a comment -

Here's the patch for multiple faq .fml files processing in the faq-plugin.
It includes a "cvs diff -u" for the changed plugin.jelly file and a collection of the few new files.

The patch is made against HEAD 20031009.

Show
Per Olesen added a comment - Here's the patch for multiple faq .fml files processing in the faq-plugin. It includes a "cvs diff -u" for the changed plugin.jelly file and a collection of the few new files. The patch is made against HEAD 20031009.
Hide
Permalink
dion gillard added a comment -

I don't think you need the FileHelper class.

Check how the xdoc plugin does it using a 'mapper'.

Show
dion gillard added a comment - I don't think you need the FileHelper class. Check how the xdoc plugin does it using a 'mapper'.
Hide
Permalink
Per Olesen added a comment -

Okay thanks! Actually I fiddled a lot with it, to and do it all in jelly. I'll give it a try some time tonight I think

Show
Per Olesen added a comment - Okay thanks! Actually I fiddled a lot with it, to and do it all in jelly. I'll give it a try some time tonight I think
Hide
Permalink
Per Olesen added a comment -

Okay, I've had a look at how the xdoc plugin does it. Of course, you were right. I could very well do without the FileHelper class.

So, I removed FileHelper, and did it all in Jelly using the CaseInsensitiveGlobPatternMapper.

I'm going to attach a new patch i a minute!

Thanx!

Show
Per Olesen added a comment - Okay, I've had a look at how the xdoc plugin does it. Of course, you were right. I could very well do without the FileHelper class. So, I removed FileHelper, and did it all in Jelly using the CaseInsensitiveGlobPatternMapper. I'm going to attach a new patch i a minute! Thanx!
Hide
Permalink
Per Olesen added a comment -

A patch for faq to handle multiple .fml file transformations, which does not use the FileHelper class.
Actually also fixes a TODO in the faq-plugin, about making it a defined tag.

Show
Per Olesen added a comment - A patch for faq to handle multiple .fml file transformations, which does not use the FileHelper class. Actually also fixes a TODO in the faq-plugin, about making it a defined tag.
Hide
Permalink
dion gillard added a comment -

Patch applied with small change.
Test project added.
Fixed in 1.2-SNAPSHOT

Show
dion gillard added a comment - Patch applied with small change. Test project added. Fixed in 1.2-SNAPSHOT
Hide
Permalink
dion gillard added a comment -

I think this deserves a release of the FAQ plugin.

Thoughts?

Show
dion gillard added a comment - I think this deserves a release of the FAQ plugin. Thoughts?
Hide
Permalink
Per Olesen added a comment -

Would be nice with a release yes.

One thought though. I came to think about backward compatibility. Anyone having used the previous src and dest file properties - eg. to name the dest not like src - will have a broken build (broken links) in their docs.

Maybe we should issue a warning, if the old props are set?

Show
Per Olesen added a comment - Would be nice with a release yes. One thought though. I came to think about backward compatibility. Anyone having used the previous src and dest file properties - eg. to name the dest not like src - will have a broken build (broken links) in their docs. Maybe we should issue a warning, if the old props are set?

People

Vote (1)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Codehaus. Try JIRA - bug tracking software for your team.