[jira] Created: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

classic Classic list List threaded Threaded
15 messages Options
Reply | Threaded
Open this post in threaded view
|

[jira] Created: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
create a maven plugin to process confluence content into docbook xml
--------------------------------------------------------------------

                 Key: CAMEL-47
                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
             Project: Apache Camel
          Issue Type: Improvement
          Components: tooling
    Affects Versions: 1.0
            Reporter: Jonas Lim
            Assignee: Jonas Lim
             Fix For: 1.1



The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.

Here's an example of the book for ActiveMQ
https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/






--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39414 ]

Jonas Lim commented on CAMEL-47:
--------------------------------

added initial source for the maven plugin and  docbook project at  :

https://svn.apache.org/repos/asf/activemq/camel/trunk/camel-book 
https://svn.apache.org/repos/asf/activemq/camel/trunk/tooling/maven/maven-html-to-docbook/

r547564

The docbook transformation still needs a lot of improvement in the following   :
1. handling of images - currently does not handle images
2. handling of href links (current transformation converts all local links to complete url ie. http://activemq.apache.org/camel/user-guide.html)
3. improving the format of the docbook markup

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Work started: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

     [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Work on CAMEL-47 started by Jonas Lim.

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39422 ]

James Strachan commented on CAMEL-47:
-------------------------------------

Great work!

Does the build work for you btw; when I tried it I got...

[INFO] [docbkx:generate-pdf {execution: default}]
[INFO] Processing Camel.xml
Error
  Failure reading /workspace/java/camel/camel-book/target/docbkx/source/Camel.xml: /workspace/java/camel/camel-book/target/docbkx/source/index.xml  (No such file or directory)

which is a bit bizarre as that file does exist

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39438 ]

Jonas Lim commented on CAMEL-47:
--------------------------------

I seem to have  left out an extra space on  the entity declarion in the main docbook  xml (Camel.xml). Windows  was just ignoring this space so it was builiding in my environment.

updated the maven docbook plugin at : r548256



> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39456 ]

Jonas Lim commented on CAMEL-47:
--------------------------------

added  process to download all image files  and store them where the html output can reference them.  Next would be to figure out how to apply this for the pdf output

r:549119

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39467 ]

James Strachan commented on CAMEL-47:
-------------------------------------

BTW I've updated the pom to include a decent amount of content; though it seems to break the generator now. Not sure why.

It seemed to be when I added all the enterprise integration pattern pages; I tried looking at the XML to see if I could grok why things bafed but I couldn't spot it - any ideas?

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39468 ]

James Strachan commented on CAMEL-47:
-------------------------------------

Incidentally, could we change the XSL so that the <chapter><title> is actually the <h1> heading on the page? Right now the chapter headings are the file names which are not great as they are lower case and have - in them :)

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39470 ]

James Strachan commented on CAMEL-47:
-------------------------------------

BTW I was wondering; should we switch the phase that the docbook generation happens to the site phase? Then the build only kicks in when creating the site etc.

(We probably wanna also copy the HTML and PDF to the site/doc directory or something so that site:deploy will deploy the PDFs etc)

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39471 ]

James Strachan commented on CAMEL-47:
-------------------------------------

Oh one more thought :) When we get the PDF generation thingy working again; we should include the PDF and HTML versions in the distro. Maybe in

doc/
  reference/
     html/
     camel.pdf


Then we've somewhere we can put the site / javadoc in there later on

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39507 ]

Jonas Lim commented on CAMEL-47:
--------------------------------

added  updates to
 -  use the first h1/h2 find as the page heading
 -  change the plugin phase to site
 - handle duplicate anchor/bridgehead ids - this was causing the generator to break on book-pattern-appendix.html and book-component-appendix.html resources

images are now handled nicely in html but still needs work when to support pdf output.  Another thing to work on are the html links. It would be nice if the  links are  inside the docbook :)

rev: 550436
 

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39508 ]

James Strachan commented on CAMEL-47:
-------------------------------------

to make it easier to track the various bits and pieces, I'm gonna create a few sub-tasks

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39512 ]

James Strachan commented on CAMEL-47:
-------------------------------------

BTW I just moved the camel-book module into the tooling directory (as new users won't really need to look much at this module as its mostly a tool to create the PDF from the wiki)

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Commented: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

    [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_39591 ]

James Strachan commented on CAMEL-47:
-------------------------------------

Great work Jonas - its looking good! :)

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1.0
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.

Reply | Threaded
Open this post in threaded view
|

[jira] Resolved: (CAMEL-47) create a maven plugin to process confluence content into docbook xml

JIRA jira@apache.org
In reply to this post by JIRA jira@apache.org

     [ https://issues.apache.org/activemq/browse/CAMEL-47?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

James Strachan resolved CAMEL-47.
---------------------------------

    Resolution: Fixed

Hiram's change to use princexml.com fixes this issue.

I've refactored the camel-book module to be called camel-manual now and it generates both a HTML and PDF representation nicely now in target/site/manual/

Note that you must have princexml.com installed for this to work!

> create a maven plugin to process confluence content into docbook xml
> --------------------------------------------------------------------
>
>                 Key: CAMEL-47
>                 URL: https://issues.apache.org/activemq/browse/CAMEL-47
>             Project: Apache Camel
>          Issue Type: Improvement
>          Components: tooling
>    Affects Versions: 1.0.0
>            Reporter: Jonas Lim
>            Assignee: Jonas Lim
>             Fix For: 1.1.0
>
>
> The content of the docbook would exist inside confluence and have the tool retrieve it and  transform them nicely into a docbook format.
> Here's an example of the book for ActiveMQ
> https://svn.apache.org/repos/asf/activemq/trunk/activemq-book/

--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.