OurBigBook logoOurBigBook Docs OurBigBook logoOurBigBook.comSite Source Code
The "home article" is the first article of the toplevel index file. E.g. in:
README.bigb
= John Smith's Homepage

== I like dogs
then "John Smith's Homepage" is the home article, but "I like dogs" is not.
The home article has some special handling done to it, notably:
  • it renders as "Home" in many places as such as the breadcrumb, a way to make things more unified and succinct, especially on web
  • it automatically gets two IDs:
    • a main empty ID
    • a synonym to that empty ID
    For example we could write:
    = John Smith's Homepage
    
    == I like dogs
    
    This is my homepage: <>
    
    And also: <John Smith's Homepage>
    Here
    • <> renders as "Home"
    • <John Smith's Homepage> renders as John Smith's Homepage
    but both link to the same location
    As a consequence of the ID being empty, you have to set \H parent argument of subsequent headers to empty if you witsh to use them as in:
    = John Smith's Homepage
    
    = I like dogs
    {parent=}
    Doing:
    = John Smith's Homepage
    
    = I like dogs
    {parent=John Smith's Homepage}
    doesn't current work because the ID john-smith-s-homepage is just a synonym to the empty ID, and you can't currently set parent= to point to synonyms:
    This is because the ID John Smith's Homepage
    You can prevent a second ID from being giving by simply setting the ID to be explicitly empty:
    = John Smith's Homepage
    {id=}
    which would generte just a single empty ID.

Ancestors (5)

  1. The toplevel index file
  2. Project toplevel directory
  3. Index file
  4. OurBigBook CLI
  5. Home

Synonyms (1)