{"id":46087821,"url":"https://github.com/cppalliance/antora-cpp-tagfiles-extension","last_synced_at":"2026-03-01T17:02:48.062Z","repository":{"id":250215433,"uuid":"833857121","full_name":"cppalliance/antora-cpp-tagfiles-extension","owner":"cppalliance","description":"C++ Tagfiles Extension for Antora","archived":false,"fork":false,"pushed_at":"2025-11-12T07:47:29.000Z","size":155,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2025-11-12T09:24:55.313Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cppalliance.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE_1_0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-07-25T22:57:17.000Z","updated_at":"2025-11-12T07:40:42.000Z","dependencies_parsed_at":"2024-07-25T23:19:23.154Z","dependency_job_id":"e8938e60-d1f9-4316-8379-c12bbf9abcd3","html_url":"https://github.com/cppalliance/antora-cpp-tagfiles-extension","commit_stats":null,"previous_names":["alandefreitas/antora-cpp-tagfiles-extension","cppalliance/antora-cpp-tagfiles-extension"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/cppalliance/antora-cpp-tagfiles-extension","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cppalliance%2Fantora-cpp-tagfiles-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cppalliance%2Fantora-cpp-tagfiles-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cppalliance%2Fantora-cpp-tagfiles-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cppalliance%2Fantora-cpp-tagfiles-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cppalliance","download_url":"https://codeload.github.com/cppalliance/antora-cpp-tagfiles-extension/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cppalliance%2Fantora-cpp-tagfiles-extension/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29976272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-03-01T17:02:46.242Z","updated_at":"2026-03-01T17:02:48.052Z","avatar_url":"https://github.com/cppalliance.png","language":"JavaScript","readme":"= Antora {cpp} Tagfiles Extension\n\nThis extension allows you to use tagfiles with {cpp} symbols in your Antora projects. Tagfiles are usually generated by Doxygen and contain information about the symbols in your {cpp} codebase.\n\n[source,asciidoc]\n----\ncpp:std::vector[]\n----\n\nThis will render as a link to the `std::vector` class in the tagfile.\n\n[source,asciidoc]\n----\nhttps://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]`.\n\nThe extension supports fundamental types, custom tagfiles, using namespaces directives, template parameters, nested symbols, and replacing target names.\n\n== Configuration\n\n=== npm\n\nInstall this extension\n\n[source,bash]\n----\nnpm i -D @cppalliance/antora-cpp-tagfiles-extension\n----\n\n=== Playbook\n\nAppend the following in your `antora-playbook.yaml`:\n\n[source,yaml]\n----\nantora:\n  extensions:\n    - require: '@cppalliance/antora-cpp-tagfiles-extension' # \u003c1\u003e\n      cpp-tagfiles:\n          files: # \u003c2\u003e\n            - file: ./doc/tagfiles/boost-url-doxygen.tag.xml\n              base_url: 'xref:reference:'\n            - file: ./doc/tagfiles/boost-system-doxygen.tag.xml\n              base_url: https://www.boost.org/doc/libs/master/libs/system/doc/html/\n            - file: ./doc/tagfiles/boost-core-doxygen.tag.xml\n              base_url: https://www.boost.org/doc/libs/master/libs/core/doc/html/\n            - file: ./doc/tagfiles/boost-filesystem-doxygen.tag.xml\n              base_url: https://www.boost.org/doc/libs/master/libs/filesystem/doc/\n          using-namespaces: \u003c3\u003e\n            - boost::urls\n            - boost::urls::grammar\n            - boost::system\n            - boost::core\n----\n\n* \u003c1\u003e `npm` package name: `@cppalliance/antora-cpp-tagfiles-extension` (required)\n* \u003c2\u003e List of tagfiles to be used by the extension\n* \u003c3\u003e List of namespaces to be used by the extension\n\n=== Components\n\nComponents can also set their own tagfiles.\nAppend following in your `antora.yaml`:\n\n[source,yaml]\n----\next:\n  cpp-tagfiles: # \u003c1\u003e\n      files: # \u003c2\u003e\n        - file: ./doc/tagfiles/boost-url-doxygen.tag.xml\n          base_url: 'xref:reference:'\n        - file: ./doc/tagfiles/boost-system-doxygen.tag.xml\n          base_url: https://www.boost.org/doc/libs/master/libs/system/doc/html/\n        - file: ./doc/tagfiles/boost-core-doxygen.tag.xml\n          base_url: https://www.boost.org/doc/libs/master/libs/core/doc/html/\n        - file: ./doc/tagfiles/boost-filesystem-doxygen.tag.xml\n          base_url: https://www.boost.org/doc/libs/master/libs/filesystem/doc/\n      using-namespaces: \u003c3\u003e\n        - boost::urls\n        - boost::urls::grammar\n        - boost::system\n        - boost::core\n----\n\n* \u003c1\u003e The playbook needs to have the extension enabled\n* \u003c2\u003e List of tagfiles to be used by the component\n* \u003c3\u003e List of namespaces to be used by the component\n\nThese tagfiles only affect the component where they are defined.\n\n=== {cpp} Reference\n\nThe extension include the cppreference tagfile by default.\nAny unknown symbol in custom tagfiles will be searched in the cppreference tagfile.\n\n=== Using the reference extension\n\nWhen `@cppalliance/antora-cpp-reference-extension` (https://github.com/cppalliance/antora-cpp-reference-extension) is present in the same playbook the reference tagfile is registered automatically, so `cpp:` macros can link to the pages generated during the same build. If you override the module name via `module`, that module’s `xref:` prefix is carried along automatically and no extra configuration is necessary:\n\n[source,yaml]\n----\nantora:\n  extensions:\n    - require: '@cppalliance/antora-cpp-reference-extension'\n    - require: '@cppalliance/antora-cpp-tagfiles-extension'\n----\n\nYou can still list extra tagfiles in the playbook or component descriptors if you need to point at other libraries, but the generated reference module is picked up automatically.\n\n== Features\n\n=== Unknown symbols\n\nIf the extension can't find a symbol in the tagfile, it will render the symbol as plain text.\n\n[source,asciidoc]\n----\ncpp:unknown[]\n----\n\nThis will render as plain text:\n\n[source,asciidoc]\n----\n`unknown`\n----\n\nWhich renders as `unknown`.\n\n==== Missing symbols\n\nBy default the extension renders missing symbols silently as simple monospace output.\nSet `missing-symbol-log-level` to any Antora log level (for example `info`, `warn`, or `error`) to emit a log entry while keeping the inline text the same.\n\n[source,yaml]\n----\nantora:\n  extensions:\n    - require: '@cppalliance/antora-cpp-tagfiles-extension'\n      cpp-tagfiles:\n        missing-symbol-log-level: warn\n        files:\n          - file: ./doc/tagfiles/boost-url-doxygen.tag.xml\n            base_url: 'xref:reference:'\n----\n\nValid values are the standard Antora log levels: `trace`, `debug`, `info`, `warn`, `error`, and `fatal`.\nUse `silent` (or leave the option unset) to suppress logging entirely.\n\n=== Fundamental types\n\nFundamental types include links to cppreference:\n\n[source,asciidoc]\n----\ncpp:int[]\n----\n\nThis will render as a link to the `int` fundamental type in cppreference.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=\"_blank\"]`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=\"_blank\"]`.\n\n=== Symbols from Tagfiles\n\nSymbols from tagfiles are rendered as links:\n\n[source,asciidoc]\n----\ncpp:std::string[]\n----\n\nThis will render as a link to the `std::string` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/string/basic_string[std::string,window=\"_blank\"]`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/string/basic_string[std::string,window=\"_blank\"]`.\n\nTemplate classes without parameters are also supported:\n\n[source,asciidoc]\n----\ncpp:std::vector[]\n----\n\nThis will render as a link to the `std::vector` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]`.\n\nSymbols from custom tagfiles are rendered without the `window=\"_blank\"` attribute if the `base_url` relative.\n\n[source,asciidoc]\n----\ncpp:is_charset[]\n----\n\nThis will render as a link to the `boost::urls::grammar::is_charset` class in the `boost-url-doxygen.tag.xml` tagfile.\n\n[source,asciidoc]\n----\n`xref:reference:boost/urls/grammar/is_charset.adoc[boost::urls::grammar::is_charset]`\n----\n\n=== Components\n\nWhen components define their own tagfiles, these tagfiles only affect the component where they are defined and they have precedence over tagfiles defined in the playbook.\n\n[source,asciidoc]\n----\ncpp:boost::urls::string_token::assign_to[]\n----\n\nThis will render as a link to the `boost::urls::string_token::assign_to` class in the `boost-url-doxygen.tag.xml` tagfile.\n\n[source,asciidoc]\n----\n`xref:reference:boost/urls/string_token/assign_to.adoc[boost::urls::string_token::assign_to]`\n----\n\nHowever, if the some other component uses `cpp:` for the same symbol without the appropriate tagfile, the symbol will be rendered as plain text.\n\n[source,asciidoc]\n----\n`boost::urls::string_token::assign_to`\n----\n\n=== Namespaces\n\nDefault namespaces can also be defined in the playbook or in the component.\nWhen there's no match for the full symbol, the extension will try to find the symbol in the namespaces.\nAssuming `boost::urls::grammar` is defined in the playbook or the component:\n\n[source,asciidoc]\n----\ncpp:boost::urls::grammar::is_charset[]\ncpp:is_charset[]\n----\n\nThis will render as a link to the `boost::urls::grammar::is_charset` class in the `boost-url-doxygen.tag.xml` tagfile.\nHowever, the link text will be whatever was provided to the extension.\n\n[source,asciidoc]\n----\n`xref:reference:boost/urls/grammar/is_charset.adoc[boost::urls::grammar::is_charset]`\n`xref:reference:boost/urls/grammar/is_charset.adoc[is_charset]`\n----\n\nAs with tagfiles, the namespaces defined in a component only affect that component.\nThe namespace `std::` can also be defined:\n\n[source,asciidoc]\n----\ncpp:std::string[]\ncpp:string[]\n----\n\nThis will render as a link to the `std::string` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/string/basic_string[std::string,window=\"_blank\"]`\n`https://en.cppreference.com/w/cpp/string/basic_string[string,window=\"_blank\"]`\n----\n\n=== Template parameters\n\nTemplate parameters are supported.\nThe extension will also include links from the tagfile for the template parameters.\n\n[source,asciidoc]\n----\ncpp:std::vector\u003cint\u003e[]\n----\n\nThis will render as a link to the `std::vector\u003cint\u003e` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]\u003chttps://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=_blank]\u003e`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]\u003chttps://en.cppreference.com/w/cpp/language/types#Standard_integer_types[int,window=_blank]\u003e`.\n\nSymbols from custom tagfiles can also be used with template parameters:\n\n[source,asciidoc]\n----\ncpp:std::vector\u003curl_view\u003e[]\n----\n\nThis will render as a link to the `std::vector\u003curl_view\u003e` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\\\"_blank\\\"]\u0026#x3C;url_view\u0026#x3E;`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"blank\"]\u003curl_view\u003e`.\n\nIf the namespace `boost::urls` is being used in the context, it will also be used to resolve `url_view`:\n\n[source,asciidoc]\n----\ncpp:std::vector\u003curl_view\u003e[]\n----\n\nThis will render as a link to the `std::vector\u003curl_view\u003e` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\\\"_blank\\\"]\u0026#x3C;xref:reference:boost/urls/url_view.adoc[url_view]\u0026#x3E;`\n----\n\n=== Nested symbols\n\nThe extension supports nested symbols:\n\n[source,asciidoc]\n----\ncpp:boost::urls::url_view_base::segments[]\n----\n\nThis will render as a link to the `boost::urls::url_view_base::segments` class in the `boost-url-doxygen.tag.xml` tagfile.\n\n[source,asciidoc]\n----\n`xref:reference:boost/urls/url_view_base/segments.adoc[boost::urls::url_view_base::segments]`\n----\n\nWhich is the page for the `boost::urls::url_view_base::segments` symbol defined in the tagfile rather than only `boost::urls::url_view_base`.\n\nSometimes there's no page for the nested symbol in the tagfile, so the link will redirect to the page for the parent symbol.\n\n[source,asciidoc]\n----\ncpp:std::vector::iterator[]\n----\n\nThis will render as a link to the `std::vector` class in the cppreference tagfile:\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window=\\\"_blank\\\"]`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window=\"blank\"]`.\n\nNote that there's no page for `std::vector::iterator` in cppreference, so the link will redirect to the page for the parent `std::vector` symbol.\n\nTemplates and nested symbols can also be combined:\n\n//       {\n//         \"input\": \"std::vector\u003curl_view_base::segments\u003e::iterator\",\n//         \"output\": \"https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\\\"_blank\\\"]\u0026#x3C;url_view_base::segments\u0026#x3E;::https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window=\\\"_blank\\\"]\"\n//       }\n\n[source,asciidoc]\n----\ncpp:std::vector\u003curl_view_base::segments\u003e::iterator[]\n----\n\nThis will render as a link to the `std::vector\u003curl_view_base::segments\u003e::iterator` class in the cppreference tagfile.\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[std::vector,window=\"_blank\"]\u0026#x3C;xref:reference:boost/urls/url_view_base/segments.adoc[url_view_base::segments]\u0026#x3E;::https://en.cppreference.com/w/cpp/container/vector[std::vector::iterator,window=\"_blank\"]\n`\n----\n\n=== Replacing target names\n\nThe extension can replace the target names of the links.\n\n[source,asciidoc]\n----\ncpp:std::vector[sequential container]\n----\n\nThis will render as a link to the `std::vector` class in the cppreference tagfile with the text \"sequential container\".\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[sequential container,window=\"_blank\"]`\n----\n\nWhich renders as `https://en.cppreference.com/w/cpp/container/vector[sequential container,window=\"_blank\"]`.\n\nWhen providing custom text for a template class, the extension will only link the main symbol:\n\n[source,asciidoc]\n----\ncpp:std::vector\u003cint\u003e[sequential container]\n----\n\nThis will render as a link to the `std::vector` class in the cppreference tagfile with the text \"sequential container\".\n\n[source,asciidoc]\n----\n`https://en.cppreference.com/w/cpp/container/vector[sequential container,window=\"_blank\"]`\n----\n\nWhich also renders as `https://en.cppreference.com/w/cpp/container/vector[sequential container,window=\"_blank\"]`.\n\n[source,asciidoc]\n----\ncpp:url_view_base::segments[URL segments]\n----\n\nThis will render as a link to the `boost::urls::url_view_base::segments` class in the `boost-url-doxygen.tag.xml` tagfile with the text \"URL segments\".\n\n[source,asciidoc]\n----\n`xref:reference:boost/urls/url_view_base/segments.adoc[URL segments]`\n----\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcppalliance%2Fantora-cpp-tagfiles-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcppalliance%2Fantora-cpp-tagfiles-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcppalliance%2Fantora-cpp-tagfiles-extension/lists"}