Skip to content

feat: navigation button links to enclosing namespace #771

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

feat: navigation button links to enclosing namespace #771

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2f2f022
feat: navigation button links to enclosing namespace
fpelliccioni Dec 19, 2024
8be8266
Merge branch 'develop' into feat/navigate-to-enclosing-namespace
fpelliccioni Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion share/mrdocs/addons/generator/adoc/layouts/wrapper.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Breadcrumbs are included in the symbol template as an alternative.
}}
= {{> symbol/qualified-name symbol }}
= {{> symbol/enclosing-namespace symbol }}{{> symbol/qualified-name symbol }}
Copy link
Collaborator

@alandefreitas alandefreitas Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This worsens things because we have removed the links to other enclosing namespaces, which the qualified-name partial does. It's removing a feature rather than including one.

Copy link
Collaborator

@alandefreitas alandefreitas Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was surprised the test files didn't change. I think it's because tests bypass the wrapper. But losing this information about the enclosing namespaces in real documentation like Boost.URL sure looks bad.

{{!
Antora does not support relative links to pages in
parent directories. Therefore, unlike in HTML templates,
Expand Down
14 changes: 14 additions & 0 deletions share/mrdocs/addons/generator/common/partials/symbol/enclosing-namespace.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{{!--
Renders a link to the enclosing namespace with a custom symbol (⬆).
If no enclosing namespace exists, nothing is rendered.
Expected Context: {Symbol Object}
Example:
{{> symbol/enclosing-namespace symbol }}
See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference
--}}
{{~#if (and parent parent.name)~}}
xref:{{{remove_prefix parent.url "/"}}}[⬆]
Copy link
Collaborator

@alandefreitas alandefreitas Dec 19, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

xref is not valid HTML. These common partials are used by both generators. See the other partials in this folder.

{{~/if~}}
Loading