diff --git a/docs/modules/ROOT/pages/generators.adoc b/docs/modules/ROOT/pages/generators.adoc index 1018d4fe8..e72de4de1 100644 --- a/docs/modules/ROOT/pages/generators.adoc +++ b/docs/modules/ROOT/pages/generators.adoc @@ -47,7 +47,9 @@ The templates used to generate the documentation are located in the `share/mrdoc addons: /path/to/custom/addons ---- -Each symbol goes through a main layout template in the `share/mrdocs/addons/generator//layouts` directory. The multipage generator renders the layout as separate pages for each symbol. The single-page generator renders and concatenates the layout. +Each symbol goes through a main layout template in the `share/mrdocs/addons/generator//layouts/single-symbol..hbs` directory. + +The multipage generator renders the layout multiple times as separate pages for each symbol. The single-page generator renders the layout multiple times and concatenates the results in a single page. Each time the generator encounters a symbol, it renders the layout template with the symbol data as the Handlebars context. The layout template can include other partial templates to render the symbol data. These partials are available in the `share/mrdocs/addons/generator//partials` directory. diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/overload-set.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/overload-set.adoc.hbs index d2bea4821..4fe6b9d96 100644 --- a/share/mrdocs/addons/generator/asciidoc/layouts/overload-set.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/layouts/overload-set.adoc.hbs @@ -1,3 +1,4 @@ +{{! A page when the symbol type is "overloads" }} {{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}} [#{{sectionref}}] diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/page.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/page.adoc.hbs deleted file mode 100644 index 266927ee7..000000000 --- a/share/mrdocs/addons/generator/asciidoc/layouts/page.adoc.hbs +++ /dev/null @@ -1,3 +0,0 @@ -={{#unless is_multipage}}={{/unless}} Reference -:mrdocs: -{{>symbol}} diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/single-footer.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/single-footer.adoc.hbs index 7638fe4ef..eda16c27e 100644 --- a/share/mrdocs/addons/generator/asciidoc/layouts/single-footer.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/layouts/single-footer.adoc.hbs @@ -1,2 +1,3 @@ +{{! The footer for single page documentation }} Created with MrDocs diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/single-header.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/single-header.adoc.hbs index f0e8a6670..6d6ad46e1 100644 --- a/share/mrdocs/addons/generator/asciidoc/layouts/single-header.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/layouts/single-header.adoc.hbs @@ -1,2 +1,3 @@ +{{! The header for single page documentation }} = Reference :mrdocs: diff --git a/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs index d155de211..db5e44c86 100644 --- a/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/layouts/single-symbol.adoc.hbs @@ -1,3 +1,4 @@ +{{! The section with a symbol in single page output or the symbol page in multi page output }} {{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}} [#{{sectionref}}] diff --git a/share/mrdocs/addons/generator/html/layouts/overload-set.html.hbs b/share/mrdocs/addons/generator/html/layouts/overload-set.html.hbs index d1ce02e7d..983a9286c 100644 --- a/share/mrdocs/addons/generator/html/layouts/overload-set.html.hbs +++ b/share/mrdocs/addons/generator/html/layouts/overload-set.html.hbs @@ -1,3 +1,4 @@ +{{! A page when the symbol type is "overloads" }} {{#if relfileprefix}}{{/if}}
diff --git a/share/mrdocs/addons/generator/html/layouts/page.html.hbs b/share/mrdocs/addons/generator/html/layouts/page.html.hbs deleted file mode 100644 index 67b7359ed..000000000 --- a/share/mrdocs/addons/generator/html/layouts/page.html.hbs +++ /dev/null @@ -1,9 +0,0 @@ - - - -
-

Reference

- {{>symbol}} -
- - \ No newline at end of file diff --git a/share/mrdocs/addons/generator/html/layouts/single-footer.html.hbs b/share/mrdocs/addons/generator/html/layouts/single-footer.html.hbs index 3fe3a9956..6deb8774e 100644 --- a/share/mrdocs/addons/generator/html/layouts/single-footer.html.hbs +++ b/share/mrdocs/addons/generator/html/layouts/single-footer.html.hbs @@ -1,3 +1,4 @@ +{{! The footer for single page documentation }}

Created with MrDocs

diff --git a/share/mrdocs/addons/generator/html/layouts/single-header.html.hbs b/share/mrdocs/addons/generator/html/layouts/single-header.html.hbs index 3ba446a02..b34176b4e 100644 --- a/share/mrdocs/addons/generator/html/layouts/single-header.html.hbs +++ b/share/mrdocs/addons/generator/html/layouts/single-header.html.hbs @@ -1,3 +1,4 @@ +{{! The header for single page documentation }} diff --git a/share/mrdocs/addons/generator/html/layouts/single-symbol.html.hbs b/share/mrdocs/addons/generator/html/layouts/single-symbol.html.hbs index b07821eca..915f24a30 100644 --- a/share/mrdocs/addons/generator/html/layouts/single-symbol.html.hbs +++ b/share/mrdocs/addons/generator/html/layouts/single-symbol.html.hbs @@ -1,3 +1,4 @@ +{{! The section with a symbol in single page output or the symbol page in multi page output }} {{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}} [#{{#if (is_multipage)}}{{symbol.id}}{{else}}{{symbol.ref}}{{/if}}]