[
https://jira.codehaus.org/browse/MSITE-82?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Michael Osipov updated MSITE-82:
--------------------------------
Labels: close-pending (was: )
> M2 Site Plugin too strict about document structure
> --------------------------------------------------
>
> Key: MSITE-82
> URL: https://jira.codehaus.org/browse/MSITE-82
> Project: Maven Site Plugin
> Issue Type: New Feature
> Affects Versions: 2.0-beta-4
> Environment: Java 1.5, WinXP SP2
> Reporter: John R Fallows
> Labels: close-pending
>
> Site generation generally assumes total ownership of the generated HTML
> content, such that complete HTML pages are expected to be generated.
> Therefore, strict rules are specified when parsing APT documentation files as
> input to site generation process, to make sure that APT files have full page
> structure.
> Unfortunately, this restriction is too brittle for Java.Net based Maven2
> projects that want to generate site documentation.
> Java.Net adds chrome dynamically at runtime to all pages (not a problem) but
> it also adds a project summary and a header for the project "Description"
> around any HTML content in the top level index.html page for a project.
> This means that the generated index.html page needs to have a structure such
> as <p>...</p><h2>Next Section</h2><p>...</p>.
> As you can see, this is not a valid HTML document, but an HTML fragments.
> Unfortunately, the APT parser is too strict to support the corresponding
> index.apt syntax logically required to produce such an index.html.
> Please allow the syntax checking during parsing to be relaxed as necessary to
> achieve the desired generated HTML.
> As mentioned by Brett, we could support out-of-order elements, but with
> warnings This might be generally useful for fragment generation in general,
> anywhere a server-side include could be used by the generated site.
> However, if we take this approach, it would be useful to be able to still get
> a clean build with no warnings, possibly by specifying which site files are
> fragments so that warnings could still be generated for user errors in other
> non-fragment pages.
> Perhaps the .aptf extension could be used to indicate a fragment APT file.
--
This message was sent by Atlassian JIRA
(v6.1.6#6162)
