You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucene.apache.org by "Uwe Schindler (JIRA)" <ji...@apache.org> on 2012/04/22 02:18:32 UTC
[jira] [Created] (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 created LUCENE-4008:
-------------------------------------
Summary: 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
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
[jira] [Resolved] (LUCENE-4008) Use Java Markdown provided by Ivy
to transform BUILD.txt, MIGRATE.txt,.. to simple (better readable) HTML and
place under documentation.
Posted by "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 resolved LUCENE-4008.
-----------------------------------
Resolution: Fixed
Assignee: Uwe Schindler
Committed trunk revision: 1328978
> 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
> Assignee: Uwe Schindler
> Fix For: 4.0
>
> Attachments: LUCENE-4008.patch, LUCENE-4008.patch, LUCENE-4008.patch, LUCENE-4008.patch, 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
[jira] [Commented] (LUCENE-4008) Use Java Markdown provided by Ivy
to transform BUILD.txt, MIGRATE.txt,.. to simple (better readable) HTML and
place under documentation.
Posted by "Uwe Schindler (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4008?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13258972#comment-13258972 ]
Uwe Schindler commented on LUCENE-4008:
---------------------------------------
Pegdown: https://github.com/sirthias/pegdown
> 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
>
>
> 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
[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.
Posted by "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
[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.
Posted by "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
Small improvements in the macro/javascript:
- Use StringBuffer, so handling the large CHANGES.txt is more effective
- Only convert markdown if target file is older than source (default <copy/> behaviour (I had the overwrite setting enabled to debug better).
- Remove useless import
> 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, LUCENE-4008.patch, LUCENE-4008.patch, 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
[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.
Posted by "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
More compact patch and invocation using todir="" and nested filesets.
> 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, 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
[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.
Posted by "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 the latest patch with MIGRATE.txt already converted:
- MIGRATE.txt was migrated to pegdown, was very easy. There are only few things to take care: Code must be indented by TAB or *four* spaces, Secrion headers start with #, ##, or ###. Lists start with * or -
- BUILD.txt was not touched or added, as you dont need build instructions anymore once you have the full documentation
- README.txt was minimalized and only points to the HTML docu.
We still need a system requirements page. Ideally as markdown, too.
I will commit that now as a start.
> 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, LUCENE-4008.patch, LUCENE-4008.patch, LUCENE-4008.patch, 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
[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.
Posted by "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
I offered to also include CHANGES.txt as markdown interpreted (to show that it looks not too bad).
Here new patch, also converting CHANGES.txt to the documentation directory. Also made the pegdown macro be more verbose and allow flatten.
> 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, LUCENE-4008.patch, 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
[jira] [Commented] (LUCENE-4008) Use Java Markdown provided by Ivy
to transform BUILD.txt, MIGRATE.txt,.. to simple (better readable) HTML and
place under documentation.
Posted by "Robert Muir (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/LUCENE-4008?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13259224#comment-13259224 ]
Robert Muir commented on LUCENE-4008:
-------------------------------------
+1, i think we should just commit this (excluding CHANGES.txt for now, as changes2html looks nicer).
I can help with the files (adding markers for headings/bullets) so they look nice, and linking them
into the index.html docs.
awesome idea!
> 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, LUCENE-4008.patch, LUCENE-4008.patch, 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