Maven Doxia

Snippet macro should include whole file if no id is given

Details

  • Type: Improvement Improvement
  • Status: Closed Closed
  • Priority: Major Major
  • Resolution: Fixed
  • Affects Version/s: 1.0-alpha-9
  • Fix Version/s: 1.1
  • Component/s: Core, Documentation
  • Labels:
    None
  • Number of attachments :
    0

Description

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:

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

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.

Activity

There are no comments yet on this issue.

People

Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: