[jira] [Updated] (LUCENE-4008) Use Java Markdown provided by Ivy to transform BUILD.txt, MIGRATE.txt,.. to simple (better readable) HTML and place under documentation.

["Uwe Schindler (JIRA)" <ji...@apache.org>]

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

Uwe Schindler updated LUCENE-4008:
----------------------------------

    Attachment: LUCENE-4008.patch

Attached a first patch to demonstate the idea. The patch adds a new <pegdown/> macro to common-build.xml that can convert any TXT file to a HTML representation (if the syntax is fine). It has some hacks:
- It uses the first line of the TXT file as HTML page title
- It converts the first line to a first level heading
- It rewrites LUCENE-xxx/SOLR-xxx identifiers to Markdown Links to JIRA

The patch converts a few files (including CHANGES.txt!!!) to HTML using that macro and places them in build/docs, no linking at the moment.

It is visile that the files look not too bad, with some tweaking and using Markdown syntax, we can make them look nice!
                
> Use Java Markdown provided by Ivy to transform BUILD.txt, MIGRATE.txt,.. to simple (better readable) HTML and place under documentation.
> ----------------------------------------------------------------------------------------------------------------------------------------
>
>                 Key: LUCENE-4008
>                 URL: https://issues.apache.org/jira/browse/LUCENE-4008
>             Project: Lucene - Java
>          Issue Type: Improvement
>            Reporter: Uwe Schindler
>             Fix For: 4.0
>
>         Attachments: LUCENE-4008.patch
>
>
> The MIGRATE.txt and other files are very simple formatted and can be converted using Markdown.
> We can use e.g. pegdown (a Java Markdown converter) to make HTML out of them and place those in the HTML documentation. Theoretically, also CHANGES.txt might be processed by Markdown, we have to try out. Pegdown is extensible, so it could handle LUCENE-xxx JIRA links correctly.

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@lucene.apache.org
For additional commands, e-mail: dev-help@lucene.apache.org