Manual Structure

The vBulletin manual is made up of chapters which contain articles, galleries, reference files and imagemaps. Each content type corresponds to a different template in the system. The basic structure will be:

  • Chapter
    • article
    • article
  • Chapter
    • article
    • reference

There are currently five different templates available in the vBulletin Manual. These are Chapter, Article, Gallery, Reference, and Imagemap. You can specify which template to use in two ways.

  1. The name of the markdown file will be used as the default template name. i.e. article.md will use the Article template.
  2. You can specify the template to be used in the YAML header of the page using the template tag. i.e.
    template: article

Chapters are containers for articles. Each chapter should have its own taxonomy category defined in the chapter.md file. This will allow the system to automatically create a table of contents for each chapter and improve navigation.

The left navigation menu will show sub-pages of the current chapter as well.

---
title: Chapter Title
slug: chapter_title
template: chapter
taxonomy:
  category: chapter_category
  tag:
    - tag1
    - tag2
    - tag3
content:
    items:
      '@taxonomy':
        category: chapter_category
---

Articles make up the bulk of the manual's content.

---
title: Article Title
slug: article_title
template: article
taxonomy:
  category: chapter_category
  tag:
    - tag1
    - tag2
    - tag3
---

Currently there is only one gallery in the manual, it shows the images for the Theme Previews using a flexbox display.

---
title: Gallery Title
slug: gallery_title
template: gallery
taxonomy:
  category: chapter_category
  tag:
    - tag1
    - tag2
    - tag3
---

This should not be confused with the chapter of the same name. Reference pages included for reference only. Copies of the .htaccess, config.php and other files are included this way. They do not contain a lot of extra interface as it is not needed.

---
title: Reference Title
slug: reference_title
template: reference
taxonomy:
  category: chapter_category
  tag:
    - tag1
    - tag2
    - tag3
---

Image Maps use extended markup to show images with details and popup descriptions. This page type is used for the Style Variable Reference pages.

---
title: ImageMap Title
slug: imagemap_title
template: imagemap
taxonomy:
  category: chapter_category
  tag:
    - tag1
    - tag2
    - tag3
---

By default, chapters and pages are ordered by a numbered prefix placed in the directory title of each page. The format is XX.directoryname.