You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@maven.apache.org by "Lukas Theussl (JIRA)" <ji...@codehaus.org> on 2008/02/04 17:13:58 UTC

[jira] Created: (DOXIA-210) Snippet macro should include whole file if no id is given

Snippet macro should include whole file if no id is given
---------------------------------------------------------

                 Key: DOXIA-210
                 URL: http://jira.codehaus.org/browse/DOXIA-210
             Project: Maven Doxia
          Issue Type: Improvement
          Components: Core, Documentation
    Affects Versions: 1.0-alpha-9
            Reporter: Lukas Theussl
            Assignee: Lukas Theussl
             Fix For: 1.0-beta-1


Currently the snippet macro requires an id attribute, and snippets are only included if they are enclosed with the START and END demarcators. However, neither id nor demarcators are necessary if you want to include an entire file. I'd suggest to allow the following:

 {noformat} 
%{snippet|file=path/to/file.txt}
 {noformat}

which will include the whole file.txt.

Note also that the documentation at http://maven.apache.org/doxia/macros/index.html seems misleading, as it says that the demarcators are only needed if you want to include part of a file.

-- 
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-210) Snippet macro should include whole file if no id is given

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

Lukas Theussl closed DOXIA-210.
-------------------------------

    Resolution: Fixed

> Snippet macro should include whole file if no id is given
> ---------------------------------------------------------
>
>                 Key: DOXIA-210
>                 URL: http://jira.codehaus.org/browse/DOXIA-210
>             Project: Maven Doxia
>          Issue Type: Improvement
>          Components: Core, Documentation
>    Affects Versions: 1.0-alpha-9
>            Reporter: Lukas Theussl
>            Assignee: Lukas Theussl
>             Fix For: 1.0-beta-1
>
>
> Currently the snippet macro requires an id attribute, and snippets are only included if they are enclosed with the START and END demarcators. However, neither id nor demarcators are necessary if you want to include an entire file. I'd suggest to allow the following:
>  {noformat} 
> %{snippet|file=path/to/file.txt}
>  {noformat}
> which will include the whole file.txt.
> Note also that the documentation at http://maven.apache.org/doxia/macros/index.html seems misleading, as it says that the demarcators are only needed if you want to include part of a file.

-- 
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