Skip to content

Align HTML to specialized documentation#310

Merged
jason-fox merged 4 commits into
dita-bootstrap:developfrom
jason-fox:feature/docs
Jun 1, 2026
Merged

Align HTML to specialized documentation#310
jason-fox merged 4 commits into
dita-bootstrap:developfrom
jason-fox:feature/docs

Conversation

@jason-fox
Copy link
Copy Markdown
Collaborator

@jason-fox jason-fox commented May 28, 2026

This PR adds in the tabbed dialogs across the sample documentation within the the HTML plugin.

The HTML plugin *.dita is still using outputclass and <!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd"> throughout, but the text and examples now explains how to use both outputclass and specialization if installed.

This contrasts with the specialization plugin which holds the same texts, but is generated using the <!DOCTYPE topic PUBLIC "-//DITA Bootstrap//DTD DITA Bootstrap Topic//EN" "bootstrap-topic.dtd"> doctype. The specialization version is also used by the root website.

Basically one uses:

<tabbed-dialog style="pills" margin="t3">
  <section>
    <title>Specialization</title>

the other uses:

<bodydiv outputclass="nav-pills mt-3">
  <section>
    <title>Specialization</title>

Copy link
Copy Markdown
Collaborator

@infotexture infotexture left a comment

Choose a reason for hiding this comment

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

@jason-fox Makes sense to include these details in the main HTML plug-in docs, but I think we probably need to provide a bit more context. Right now, the installation instructions start with:

Optional: install the specialization plug-in

— but readers don't know what that is yet, and it feels like that's leading with the exception rather than the rule.

If we follow the pattern established for the other optional plug-ins like Lunr & Sass, we'd add a dedicated topic on the specialization plug-in under the Extend section of the docs, and link there when mentioning the specialization approach elsewhere.

As for the new tabs, I'd suggest we place the @outputclass tab first and show it by default, since that will work out of the box without installing another plug-in. Users with the specialization plug-in installed can switch tabs to show the corresponding code.

But we can merge this as is, and refine further in separate PRs.

@jason-fox jason-fox merged commit 41dc3f0 into dita-bootstrap:develop Jun 1, 2026
1 check passed
@jason-fox
Copy link
Copy Markdown
Collaborator Author

I switched the tab order and merged. I have opened up the discussion of further changes here

@jason-fox jason-fox deleted the feature/docs branch June 1, 2026 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants