Hiding files

The hide and hidefromtoc metadata items let you hide content in different ways.

Using hide

If you set hide to yes, the page is excluded from both external and internal search engines. When you turn on hide,index is set to no automatically in the output file.

If you add hide: yes to the TOC.md file, the entire guide will be excluded from external and internal search and available only through a URL.

Using hidefromtoc

If you set hidefromtoc to yes, the article does not appear in the TOC and is available only through direct links or URLs.

Example: Syntax under consideration is added to the Resources section of the TOC, but it doesn’t appear in the left nav when rendered. When you open this page, nothing is selected in the left nav.

If all articles in a TOC section are hidden from the TOC, the section is hidden in the left nav. This entire guide is hidden, but not hidden from TOC. Bob, get the published URL.

Examples of hidden files

First, Second, and Third are hidden (hide: yes) and hidden from the TOC (hidefromtoc: yes).

For a demo or test, we set hidefromtoc to no to one of these files, which then exposes the “Hidden articles” section in the left nav. Here’s what these files look like in the TOC:

+ Hidden articles {#hidden}
  + [Hidden article 1](/docs/authoring-guide-exl/using/hidden/hidden-1.html?lang=en)
  + [Hidden article 2](/docs/authoring-guide-exl/using/hidden/hidden-2.html?lang=en)
  + [Hidden article 3](/docs/authoring-guide-exl/using/hidden/hidden-3.html?lang=en)

On this page