reqlanOverviewIdeasFilesCode filesClustersAttributesGraphPrint
Ideas/html_export_url_base

Idea detail

html_export_url_base

reqlan rq/extension/features-html-export.rq:363

block done

Summary

Html export should accept an optional urlBase mount prefix ( for example `/spec` or `/reqlan/spec` ).
When set, page and asset hrefs must be root-relative under that prefix so static hosts resolve correctly whether the directory URL includes a trailing slash.
When omitted, exports keep document-relative hrefs suitable for local folder browsing.
Applies across html_export_internal_links and html_export_graph_links; site embed consumption: spec_html_export.
Often paired with html_export_header_link when the export is mounted under a parent static site.

Jump to outbound references

Jump to inbound references

Navigation

Source file

reqlan rq/extension/features-html-export.rq

community 15

community cluster

features-html-export.rq

file cluster

reqlan rq/extension

folder cluster

status: done

status cluster

tag: Not present

tag cluster

Printable page

Static print-friendly idea sheet.

Attributes

KeyValue
status done
implementation types.ts, html-export-utils.ts, build-export-snapshot.ts, html-export-template.ts, export.ts, export-spec.mts
tests export-html.test.ts

Browse all attributes

Ancestor context

html_export_internal_links

Every exported idea should have a stable html page path and stable in-page anchors. References, breadcrumbs, search results, graph nodes, cluster members, attribute listings, file listings, and code-file listings should link to html pages rather than only showing text labels. Graph node links must follow [html_export_graph_links]. When [html_export_url_base] is set, those same links must be root-relative under the mount prefix so static hosts resolve them with or without a trailing slash.

html_export_graph_links

Graph node hrefs must resolve to idea pages from every export page depth, including nested idea, file, and cluster pages. Node urls should be export-root-relative so path segments such as ideas / are not dropped when resolving from nested pages. When [html_export_url_base] is set, runtime resolution of those urls must honour the mount prefix ( same contract as page and asset hrefs ). External file nodes should resolve to [html_export_file_pages] or [html_export_code_reference_pages] when those page families are enabled.

html_export_header_link

Html export should accept an optional header link ( href + label ) rendered in the topbar ahead of section navigation. Hosts such as the marketing site build can set this so readers can return to the parent site from any exported page. When omitted, the topbar shows only the export section nav. Site embed consumption: ["../../site/reqs/core.rq".spec_html_export]. Often paired with [html_export_url_base] when the export is mounted under a parent static site.

html_export_file_pages

Html export should generate dedicated pages for reqlan source files that host ideas in the export scope. File pages should list hosted ideas, related clusters, and a local graph view when available. Emission defaults on and is controllable via includeFilePages so page families can be flagged in or out without changing the export pipeline shape. Graph nodes and idea source-file links for hosting files should resolve to these pages when enabled.

html_export_code_reference_pages

Html export should generate dedicated pages for outbound file_reference targets that are not idea-hosting reqlan files already covered by [html_export_file_pages]. Code-file pages should list referencing ideas and reference labels, and participate in search and navigation. Emission defaults on and is controllable via includeCodeFilePages so this page family can be flagged in or out later. Outbound reference path cells and graph external file nodes should link to these pages when enabled.

Outbound references

KindIdeaPathSnippet
file_reference ../../packages/analytical/src/export/build-export-snapshot.ts packages/analytical/src/export/build-export-snapshot.ts build-export-snapshot.ts
file_reference ../../packages/analytical/src/export/html-export-template.ts packages/analytical/src/export/html-export-template.ts html-export-template.ts
file_reference ../../packages/analytical/src/export/html-export-utils.ts packages/analytical/src/export/html-export-utils.ts html-export-utils.ts
file_reference ../../packages/analytical/src/export/types.ts packages/analytical/src/export/types.ts types.ts
file_reference ../../packages/analytical/test/export-html.test.ts packages/analytical/test/export-html.test.ts export-html.test.ts
file_reference ../../packages/cli/src/commands/export.ts packages/cli/src/commands/export.ts export.ts
file_reference ../../site/scripts/export-spec.mts site/scripts/export-spec.mts export-spec.mts
references html_export_graph_links reqlan rq/extension/features-html-export.rq html_export_graph_links
references html_export_header_link reqlan rq/extension/features-html-export.rq html_export_header_link
references html_export_internal_links reqlan rq/extension/features-html-export.rq html_export_internal_links

Inbound references

KindIdeaPathSnippet
references html_export reqlan rq/extension/features-html-export.rq html_export_url_base
references html_export_graph_links reqlan rq/extension/features-html-export.rq html_export_url_base
references html_export_header_link reqlan rq/extension/features-html-export.rq html_export_url_base
references html_export_internal_links reqlan rq/extension/features-html-export.rq html_export_url_base

Unresolved references

KindIdeaPathSnippet
references spec_html_export spec_html_export

Local graph

Initialising graph…