OurBigBook logoOurBigBook Docs OurBigBook logoOurBigBook.comSite Source code

\H synonym argument

This option is similar to \H title2 argument but it additionally:
  • creates a new ID that you can refer to, and renders it with the alternate chosen title
  • the rendered ID on internal links is the same as what it is a synonym for
  • the synonym header is not rendered at all, including in the table of contents
  • when using -S, --split-headers, a redirect output file is generated from the synonym to the main ID
Synonym headers must immediately follow another header, before any body content. Blank lines and consecutive synonym headers are allowed. This also applies to synonymNoScope.
Example:
= Parent

== GNU Debugger
{c}

= GDB
{c}
{synonym}

I like to say \x[gdb] because it is shorter than \x[gnu-debugger].
renders something like:
= GNU Debugger

I like to say \a[#gnu-debugger][GDB] because it is shorter than \x[#gnu-debugger][GNU Debugger].
Furthermore, if -S, --split-headers is used, another file is generated:
gdb.html
which contains a redirection from gdb.html to gnu-debugger.html.
Implemented at: github.com/ourbigbook/ourbigbook/issues/114

Ancestors (5)

  1. \H arguments
  2. Header
  3. Macro
  4. OurBigBook Markup
  5. Home

Incoming links (6)

Synonyms (1)