fix(HandlebarsGenerator): relative URLs

docs/modules/ROOT/pages/generators.adoc

@@ -83,17 +83,10 @@ The top-level object in the DOM is the context for a template.The top-level obje
 |`<<symbol-fields,Symbol Object>>`
 |The symbol being rendered.
 
-|`relfileprefix`
-|`string`
-|The relative file prefix for the output file.
-
 |`config`
 |`<<config-fields,Config Object>>`
 |The configuration object.
 
-|`sectionref`
-|`string`
-|The section reference.
 |===
 
 [#symbol-fields]
@@ -138,6 +131,21 @@ The `Symbol` object represents a symbol extracted from the source code.The symbo
 
 |===
 
+Handlebars generators extend each symbol with the following fields:
+
+|===
+|Property |Type| Description
+
+| `url`
+| `string`
+| The URL of the symbol. If the documentation is a single page, this is the anchor link to the symbol starting with `#`. If the documentation is multipage, this is the path to the symbol starting with `/`.
+
+| `anchor`
+| `string`
+| The anchor link to the symbol. This is used for section IDs in the documentation.
+
+|===
+
 The `Symbol` object has additional properties based on the kind of symbol. The following table lists the additional properties for symbols that contain information about their scope (such as Namespaces and Classes):
 
 |===

include/mrdocs/Metadata/DomCorpus.hpp

@@ -84,6 +84,17 @@ class MRDOCS_DECL
     dom::Object
     construct(Info const& I) const;
 
+    /** Return a Dom value representing an overload set.
+
+        A @ref Generator should override this member
+        and return suitable @ref dom::Value representing
+        the overload set.
+    */
+    virtual
+    dom::Object
+    construct(
+        OverloadSet const& os) const;
+
     /** Return a Dom object representing the given symbol.
 
         @return A value containing the symbol
@@ -103,19 +114,7 @@ class MRDOCS_DECL
     */
     virtual
     dom::Value
-    getJavadoc(
-        Javadoc const& jd) const;
-
-    /** Return a Dom value representing an overload set.
-
-        A @ref Generator should override this member
-        and return suitable @ref dom::Value representing
-        the overload set.
-    */
-    virtual
-    dom::Object
-    getOverloads(
-        OverloadSet const& os) const;
+    getJavadoc(Javadoc const& jd) const;
 };
 
 } // mrdocs

share/mrdocs/addons/generator/adoc/layouts/index-overload-set.adoc.hbs

@@ -1,7 +1,5 @@
 {{! A page when the symbol type is "overloads" }}
-{{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}}
-[#{{sectionref}}]
-
+[#{{symbol.anchor}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed overload set{{/if}}
 
 {{#if symbol.members.[0]}}

share/mrdocs/addons/generator/adoc/layouts/index.adoc.hbs

@@ -1,5 +1,2 @@
 {{! The section with a symbol in single page output or the symbol page in multi page output }}
-{{#if relfileprefix}}:relfileprefix: {{relfileprefix}}{{/if}}
-
-[#{{{sectionref}}}]
 {{> symbol symbol=symbol}}

share/mrdocs/addons/generator/adoc/partials/markup/a.adoc.hbs

@@ -1 +1 @@
-xref:{{{href}}}[{{> @partial-block }}]
+{{#if (starts_with href "#")}}<<{{{href}}},{{> @partial-block }}>>{{else}}xref:{{{href}}}[{{> @partial-block }}]{{/if}}

share/mrdocs/addons/generator/adoc/partials/symbols/alias.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- alias --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/concept.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- concept --}}
+[#{{{symbol.anchor}}}]
 = {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/enum.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- enum --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed enum{{/if}}
 
 {{{symbol.doc.brief}}}
@@ -18,7 +19,7 @@
 |===
 |Name |Description
 {{#each symbol.members}}
-|xref:{{{ref}}}[`pass:v[{{>types/declarator-id . nolink=true}}]`] | {{~doc.brief}}
+|xref:{{{anchor}}}[`pass:v[{{>types/declarator-id . nolink=true}}]`] | {{~doc.brief}}
 {{/each}}
 |===
 {{/if}}

share/mrdocs/addons/generator/adoc/partials/symbols/enumerator.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- enumerator --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/field.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- field --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/friend.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- friend --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.symbol}}{{>types/nested-name-specifier symbol=symbol.symbol.parent includeNamespace=true}}{{symbol.symbol.name}}{{else}}{{symbol.type.name}}{{/if}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/function.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- function --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/guide.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- guides --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/namespace.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- namespace --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else if symbol.parent}}Unnamed namespace{{else}}Global namespace{{/if}}
 
 {{>types/tranche tranche=symbol.interface label="" is-namespace=true}}

share/mrdocs/addons/generator/adoc/partials/symbols/record.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- record --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{#if symbol.name}}{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}{{else}}Unnamed class{{/if}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/typedef.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- typedef --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/undefined.adoc.hbs

@@ -1 +1,2 @@
 {{!-- undefined --}}
+[#{{{symbol.anchor}}}]

share/mrdocs/addons/generator/adoc/partials/symbols/using.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- symbols/using.adoc.hbs --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/adoc/partials/symbols/variable.adoc.hbs

@@ -1,4 +1,5 @@
 {{!-- variable --}}
+[#{{{symbol.anchor}}}]
 ={{#unless @root.config.multipage}}={{/unless}} {{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}
 
 {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/common/partials/types/declarator-id.hbs

@@ -4,7 +4,7 @@
 {{else if (eq kind "guide")~}}
     {{>types/declarator deduced nolink=nolink~}}
 {{else~}}
-    {{#if (and link.ref (not nolink))}}{{#>markup/a href=link.ref}}{{name}}{{/markup/a}}{{else}}{{name}}{{/if~}}
+    {{#if (and link.url (not nolink))}}{{#>markup/a href=(relativize link.url)}}{{name}}{{/markup/a}}{{else}}{{name}}{{/if~}}
     {{#if (or (eq template.kind "explicit") (eq template.kind "partial"))~}}
         {{>types/template-args args=template.args nolink=nolink~}}
     {{/if~}}

share/mrdocs/addons/generator/common/partials/types/info-member.hbs

@@ -1,7 +1,7 @@
 {{! Helper for "info-list": renders a symbol as a row in a table of members }}
 {{#>markup/tr~}}
 {{#>markup/td~}}
-    {{#>markup/a href=ref}}{{#>markup/code}}{{>types/declarator-id . nolink=true}}{{/markup/code}}{{/markup/a}} {{>types/special-name-suffix .}}
+    {{#>markup/a href=(relativize url)}}{{#>markup/code}}{{>types/declarator-id . nolink=true}}{{/markup/code}}{{/markup/a}} {{>types/special-name-suffix .}}
 {{~/markup/td}}
 {{#>markup/td~}}
     {{#if (ne kind "overload")~}}

share/mrdocs/addons/generator/common/partials/types/name-info.hbs

@@ -3,5 +3,5 @@
 {{>types/name-info prefix nolink=nolink~}}::
 {{~/if~}}
 {{#if (or (eq name "see-below") (eq name "implementation-defined"))~}}{{ str '_'}}{{name}}{{ str '_'}}{{else~}}
-{{#if (and symbol.ref (not nolink))}}{{#>markup/a href=symbol.ref}}{{name}}{{/markup/a}}{{else~}}
+{{#if (and symbol.url (not nolink))}}{{#>markup/a href=(relativize symbol.url)}}{{name}}{{/markup/a}}{{else~}}
 {{name}}{{/if}}{{#if args}}{{>types/template-args args=args nolink=nolink}}{{/if~}}{{/if~}}

share/mrdocs/addons/generator/common/partials/types/qualified-path.hbs

@@ -4,5 +4,5 @@
 {{>types/qualified-path symbol=symbol.parent nolink=nolink~}}
 {{else~}}
 {{/if~}}
-{{#if symbol.name}}{{#if (not nolink)}}{{#>markup/a href=symbol.ref}}{{symbol.name}}{{/markup/a}}{{else}}{{symbol.name}}{{/if}}::{{/if~}}
+{{#if symbol.name}}{{#if (not nolink)}}{{#>markup/a href=(relativize symbol.url)}}{{symbol.name}}{{/markup/a}}{{else}}{{symbol.name}}{{/if}}::{{/if~}}
 {{/unless}}

share/mrdocs/addons/generator/common/partials/types/source.hbs

@@ -9,7 +9,7 @@
         {{ str "<" }}{{#unless (and @root.config.base-url (eq dcl.kind "source"))~}}
             {{dcl.file}}
         {{~else~}}
-            {{#>markup/a href=(concat @root.config.base-url dcl.file '#L' dcl.line)}}{{dcl.file}}{{/markup/a}}>
+            {{#>markup/a href=(concat @root.config.base-url dcl.file '#L' dcl.line)}}{{dcl.file}}{{/markup/a}}
         {{~/unless~}}{{ str ">" }}
     {{~/markup/code}}
 {{~/markup/span}}

share/mrdocs/addons/generator/common/partials/types/template-arg.hbs

@@ -4,6 +4,6 @@
 {{else if (eq kind "non-type")~}}
 {{~value~}}
 {{else if (eq kind "template")~}}
-{{#if (and template (not nolink))}}xref:{{template.ref}}[{{name~}}]{{else~}}{{name~}}{{/if~}}
+{{#if (and template (not nolink))}}{{#>markup/a href=(relativize template.url)}}{{name}}{{/markup/a}}{{else~}}{{name~}}{{/if~}}
 {{/if~}}
 {{~#if is-pack}}...{{/if~}}

share/mrdocs/addons/generator/html/layouts/index-overload-set.html.hbs

@@ -1,6 +1,5 @@
 {{! A page when the symbol type is "overloads" }}
-{{#if relfileprefix}}<meta name="relfileprefix" content="{{relfileprefix}}">{{/if}}
-<div id="{{#if @root.config.multipage}}{{symbol.id}}{{else}}{{symbol.ref}}{{/if}}">
+<div id="{{{symbol.anchor}}}">
 
 <h1>{{#if symbol.name}}Overload set {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}{{else}}Unnamed overload set{{/if}}</h1>
 
@@ -11,7 +10,7 @@
 <p>{{member.doc.brief}}</p>
 
 <pre><code class="language-cpp">{{> (concat 'signature' '/' (lookup member 'kind')) symbol=member}};</code></pre>
-<a href="{{ref}}"><em>» more...</em></a>
+<a href="{{{relativize member.url}}}"><em>» more...</em></a>
 
 {{/each}}
 

share/mrdocs/addons/generator/html/partials/symbols/alias.html.hbs

@@ -1,5 +1,5 @@
 {{!-- alias --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/concept.html.hbs

@@ -1,5 +1,5 @@
 {{!-- concept --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{>types/nested-name-specifier symbol=symbol.parent includeNamespace=true}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/enum.html.hbs

@@ -1,5 +1,5 @@
 {{!-- enum --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{#if symbol.name}}Enum {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}{{else}}Unnamed enum{{/if}}</h2>
         {{{symbol.doc.brief}}}
@@ -30,7 +30,7 @@
             <tbody>
                 {{#each symbol.members}}
                 <tr>
-                    <td><a href="#{{ref}}">{{>types/declarator-id . nolink=true}}</a></td>
+                    <td><a href="#{{anchor}}">{{>types/declarator-id . nolink=true}}</a></td>
                     <td>{{{doc.brief}}}</td>
                 </tr>
                 {{/each}}

share/mrdocs/addons/generator/html/partials/symbols/enumerator.html.hbs

@@ -1,5 +1,5 @@
 {{!-- enumerator --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>Enumerator {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/field.html.hbs

@@ -1,5 +1,5 @@
 {{!-- field --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/friend.html.hbs

@@ -1,5 +1,5 @@
 {{!-- friend --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>Friend {{#if symbol.symbol}}{{symbol.symbol.name}}{{else}}{{symbol.type.name}}{{/if}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/function.html.hbs

@@ -1,5 +1,5 @@
 {{!-- function --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>Function {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/guide.html.hbs

@@ -1,5 +1,5 @@
 {{!-- guides --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>Deduction guide {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/namespace.html.hbs

@@ -1,5 +1,5 @@
 {{!-- namespace --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{#if symbol.name}}Namespace {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}{{else if symbol.parent}}Unnamed namespace{{else}}Global namespace{{/if}}</h2>
     </div>

share/mrdocs/addons/generator/html/partials/symbols/record.html.hbs

@@ -1,5 +1,5 @@
 {{!-- record --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{#if symbol.name}}Class {{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}{{else}}Unnamed class{{/if}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/typedef.html.hbs

@@ -1,5 +1,5 @@
 {{!-- typedef --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/using.html.hbs

@@ -1,5 +1,5 @@
 {{!-- symbols/using.html.hbs --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>Using {{#if (eq symbol.class "namespace")}}Directive: {{symbol.qualifier.name}}{{else}}Declaration: {{symbol.name}}{{/if}}</h2>
         {{{symbol.doc.brief}}}

share/mrdocs/addons/generator/html/partials/symbols/variable.html.hbs

@@ -1,5 +1,5 @@
 {{!-- variable --}}
-<div {{#if sectionref}}id="{{sectionref}}"{{/if}}>
+<div id="{{symbol.anchor}}">
     <div>
         <h2>{{>types/nested-name-specifier symbol=symbol.parent}}{{symbol.name}}</h2>
         {{{symbol.doc.brief}}}

src/lib/Gen/adoc/DocVisitor.cpp

@@ -260,7 +260,7 @@ operator()(doc::Reference const& I)
     if(I.id == SymbolID::invalid)
         return (*this)(static_cast<const doc::Text&>(I));
     fmt::format_to(std::back_inserter(dest_), "xref:{}[{}]",
-        corpus_.getXref(corpus_->get(I.id)), escapeAdoc(I.string));
+        corpus_.getURL(corpus_->get(I.id)), escapeAdoc(I.string));
 }
 
 std::size_t