You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@karaf.apache.org by "Christian Schneider (JIRA)" <ji...@apache.org> on 2011/06/01 10:26:52 UTC

[jira] [Created] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Use Wiki syntax in bundle.info instead of Ansi control sequences
----------------------------------------------------------------

                 Key: KARAF-664
                 URL: https://issues.apache.org/jira/browse/KARAF-664
             Project: Karaf
          Issue Type: Improvement
          Components: console
            Reporter: Christian Schneider
             Fix For: 3.0.0


Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.

I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 

The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.


--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Christian Schneider (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Christian Schneider updated KARAF-664:
--------------------------------------

    Attachment: KARAF-664.patch

> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Updated] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Guillaume Nodet (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Guillaume Nodet updated KARAF-664:
----------------------------------

    Comment: was deleted

(was: How are those translated into plain text when using the osgi:info command now ?  )

> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>            Assignee: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Christian Schneider (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13046535#comment-13046535 ] 

Christian Schneider commented on KARAF-664:
-------------------------------------------

I have written a small parser and transformation code. See:
http://svn.apache.org/viewvc/karaf/trunk/shell/osgi/src/main/java/org/apache/karaf/shell/osgi/wikidoc/WikiParser.java/?rev=1132627&view=markup
http://svn.apache.org/viewvc/karaf/trunk/shell/osgi/src/main/java/org/apache/karaf/shell/osgi/wikidoc/WikiVisitor.java/?rev=1132627&view=markup
http://svn.apache.org/viewvc/karaf/trunk/shell/osgi/src/main/java/org/apache/karaf/shell/osgi/wikidoc/AnsiPrintingWikiVisitor.java/?rev=1132627&view=markup


> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>            Assignee: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Resolved] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Christian Schneider (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Christian Schneider resolved KARAF-664.
---------------------------------------

    Resolution: Fixed

I converted all bundle.info files to the new Wiki Syntax

> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>            Assignee: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Commented] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Guillaume Nodet (JIRA)" <ji...@apache.org>.
    [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13046533#comment-13046533 ] 

Guillaume Nodet commented on KARAF-664:
---------------------------------------

How are those translated into plain text when using the osgi:info command now ?  

> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>            Assignee: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira

[jira] [Assigned] (KARAF-664) Use Wiki syntax in bundle.info instead of Ansi control sequences

Posted by "Christian Schneider (JIRA)" <ji...@apache.org>.
     [ https://issues.apache.org/jira/browse/KARAF-664?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Christian Schneider reassigned KARAF-664:
-----------------------------------------

    Assignee: Christian Schneider

> Use Wiki syntax in bundle.info instead of Ansi control sequences
> ----------------------------------------------------------------
>
>                 Key: KARAF-664
>                 URL: https://issues.apache.org/jira/browse/KARAF-664
>             Project: Karaf
>          Issue Type: Improvement
>          Components: console
>            Reporter: Christian Schneider
>            Assignee: Christian Schneider
>             Fix For: 3.0.0
>
>         Attachments: KARAF-664.patch
>
>
> Currently bundle.info is used to provide documentation for bundles. Ansi Control Characters are used to highlight Headings and Links.
> I think this is not ideal as the direct representation of a heading is written down (Like using font and color tags in html). Instead we should use Wiki syntax to represent the structure and translate this to Ansi Control characters for the console. 
> The advantages are that we can more easily change the representation and even support generating html out of the bundle.info for the website.

--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira