You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Dennis Lundberg (JIRA)" <ji...@codehaus.org> on 2007/07/28 17:27:13 UTC

[jira] Created: (DOXIA-142) Allow snippet macro contents to be output as-is, instead of verbatim

Allow snippet macro contents to be output as-is, instead of verbatim
--------------------------------------------------------------------

                 Key: DOXIA-142
                 URL: http://jira.codehaus.org/browse/DOXIA-142
             Project: Maven Doxia
          Issue Type: Improvement
          Components: Core
    Affects Versions: 1.0-alpha-8
            Reporter: Dennis Lundberg
         Attachments: snippet-non-verbatim.patch

It would be extremely useful to be able to use the snippet macro to "include" ready made content. That is not possible because the SnippetMacro class outputs the content as verbatim escaped text. This could be allowed by adding a new parameter "verbatim" to the snippet macro that defaults to "true" to preserve the current behavior.

Consider this code example
{code}
<macro name="snippet" id="mytable" file="src/site/snippets/snippets.xml" verbatim="false"/>
{code}

It would take the snippet "mytable" from the specified file and insert it "as-is".

If you like this idea I will apply the patch and add examples to the documentation as well.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Closed: (DOXIA-142) Allow snippet macro contents to be output as-is, instead of verbatim

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-142?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dennis Lundberg closed DOXIA-142.
---------------------------------

      Assignee: Dennis Lundberg
    Resolution: Fixed

Fixed in r607880.

> Allow snippet macro contents to be output as-is, instead of verbatim
> --------------------------------------------------------------------
>
>                 Key: DOXIA-142
>                 URL: http://jira.codehaus.org/browse/DOXIA-142
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Dennis Lundberg
>            Assignee: Dennis Lundberg
>             Fix For: 1.0-beta-1
>
>         Attachments: snippet-non-verbatim.patch
>
>
> It would be extremely useful to be able to use the snippet macro to "include" ready made content. That is not possible because the SnippetMacro class outputs the content as verbatim escaped text. This could be allowed by adding a new parameter "verbatim" to the snippet macro that defaults to "true" to preserve the current behavior.
> Consider this code example
> {code}
> <macro name="snippet" id="mytable" file="src/site/snippets/snippets.xml" verbatim="false"/>
> {code}
> It would take the snippet "mytable" from the specified file and insert it "as-is".
> If you like this idea I will apply the patch and add examples to the documentation as well.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-142) Allow snippet macro contents to be output as-is, instead of verbatim

Posted by "Lukas Theussl (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-142?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_103532 ] 

Lukas Theussl commented on DOXIA-142:
-------------------------------------

I like it... :)

However, shouldn't the non-verbatim text be output as text as well instead of rawText?

> Allow snippet macro contents to be output as-is, instead of verbatim
> --------------------------------------------------------------------
>
>                 Key: DOXIA-142
>                 URL: http://jira.codehaus.org/browse/DOXIA-142
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Dennis Lundberg
>         Attachments: snippet-non-verbatim.patch
>
>
> It would be extremely useful to be able to use the snippet macro to "include" ready made content. That is not possible because the SnippetMacro class outputs the content as verbatim escaped text. This could be allowed by adding a new parameter "verbatim" to the snippet macro that defaults to "true" to preserve the current behavior.
> Consider this code example
> {code}
> <macro name="snippet" id="mytable" file="src/site/snippets/snippets.xml" verbatim="false"/>
> {code}
> It would take the snippet "mytable" from the specified file and insert it "as-is".
> If you like this idea I will apply the patch and add examples to the documentation as well.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Commented: (DOXIA-142) Allow snippet macro contents to be output as-is, instead of verbatim

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
    [ http://jira.codehaus.org/browse/DOXIA-142?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_103548 ] 

Dennis Lundberg commented on DOXIA-142:
---------------------------------------

The non-verbatim text should be output as-is (rawText), without XML-escaping the characters. That way you can put an html-snippet in a file and reuse in it in multiple places, like a kind of include.

> Allow snippet macro contents to be output as-is, instead of verbatim
> --------------------------------------------------------------------
>
>                 Key: DOXIA-142
>                 URL: http://jira.codehaus.org/browse/DOXIA-142
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Dennis Lundberg
>         Attachments: snippet-non-verbatim.patch
>
>
> It would be extremely useful to be able to use the snippet macro to "include" ready made content. That is not possible because the SnippetMacro class outputs the content as verbatim escaped text. This could be allowed by adding a new parameter "verbatim" to the snippet macro that defaults to "true" to preserve the current behavior.
> Consider this code example
> {code}
> <macro name="snippet" id="mytable" file="src/site/snippets/snippets.xml" verbatim="false"/>
> {code}
> It would take the snippet "mytable" from the specified file and insert it "as-is".
> If you like this idea I will apply the patch and add examples to the documentation as well.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira

        

[jira] Updated: (DOXIA-142) Allow snippet macro contents to be output as-is, instead of verbatim

Posted by "Dennis Lundberg (JIRA)" <ji...@codehaus.org>.
     [ http://jira.codehaus.org/browse/DOXIA-142?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Dennis Lundberg updated DOXIA-142:
----------------------------------

    Fix Version/s: 1.0-beta-1

> Allow snippet macro contents to be output as-is, instead of verbatim
> --------------------------------------------------------------------
>
>                 Key: DOXIA-142
>                 URL: http://jira.codehaus.org/browse/DOXIA-142
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core
>    Affects Versions: 1.0-alpha-8
>            Reporter: Dennis Lundberg
>             Fix For: 1.0-beta-1
>
>         Attachments: snippet-non-verbatim.patch
>
>
> It would be extremely useful to be able to use the snippet macro to "include" ready made content. That is not possible because the SnippetMacro class outputs the content as verbatim escaped text. This could be allowed by adding a new parameter "verbatim" to the snippet macro that defaults to "true" to preserve the current behavior.
> Consider this code example
> {code}
> <macro name="snippet" id="mytable" file="src/site/snippets/snippets.xml" verbatim="false"/>
> {code}
> It would take the snippet "mytable" from the specified file and insert it "as-is".
> If you like this idea I will apply the patch and add examples to the documentation as well.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira