changed paramenter from toc - none to toc - false to be more standard with the way parameters are set

This commit is contained in:
tomjohnson1492
2016-03-21 10:01:34 -07:00
parent 1cb430c0a0
commit 5012328645
14 changed files with 20 additions and 18 deletions

View File

@ -23,14 +23,14 @@ entries:
output: web, pdf
items:
- title: 5.0 Release notes
url: /mydoc_release_notes_50/
output: web, pdf
- title: Get started
url: /
output: web, pdf
- title: 5.0 Release notes
url: /mydoc_release_notes_50/
output: web, pdf
- title: Introduction
url: /mydoc_introduction/
output: web, pdf

View File

@ -38,7 +38,7 @@
$('[data-toggle="tooltip"]').tooltip()
})
</script>
{% if page.datatable == "active" %}
{% if page.datatable == true %}
<link rel="stylesheet" type="text/css" href="//cdn.datatables.net/1.10.5/css/jquery.dataTables.css">
<script type="text/javascript" charset="utf8" src="//cdn.datatables.net/1.10.5/js/jquery.dataTables.js"></script>
<script>

View File

@ -12,7 +12,7 @@ layout: default
<div class="summary">{{page.summary}}</div>
{% endif %}
{% unless page.toc == "none" %}
{% unless page.toc == false %}
{% include toc.html %}
{% endunless %}

View File

@ -133,7 +133,7 @@ Keywords get populated into the metadata of the page for SEO.
Tags must be defined in your \_data/tags.yml list. You also need a corresponding tag file inside the tags folder that follows the same pattern as the other tag files shown in the tags folder. (Jekyll wont auto-create these tag files.)
```
If you don't want the mini-TOC to show on a page (such as for the homepage or landing pages), add `toc: none` in the frontmatter.
If you don't want the mini-TOC to show on a page (such as for the homepage or landing pages), add `toc: false` in the frontmatter.
## Configure the top navigation

View File

@ -6,7 +6,7 @@ tags: [special_layouts]
keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse
last_updated: November 30, 2015
summary: "You can use an accordion-layout that takes advantage of Bootstrap styling. This is useful for an FAQ page."
toc: none
toc: false
---
<p>If you want to use an FAQ format, use the syntax shown on the faq.html page. Rather than including code samples here (which are bulky with a lot of nested <code>div</code> tags), just look at the source in the mydoc_faq.html theme file.</p>

View File

@ -6,6 +6,7 @@ last_updated: March 20, 2016
summary: "Your glossary page can take advantage of definitions stored in a data file. This gives you the ability to reuse the same definition in multiple places. Additionally, you can use Bootstrap classes to arrange your definition list horizontally."
sidebar: mydoc_sidebar
permalink: /mydoc_glossary/
toc: false
---

View File

@ -6,6 +6,7 @@ last_updated: March 20, 2016
summary: "This shows a sample layout for a knowledge base. Each square could link to a tag archive page. In this example, font icons from Font Awesome are used for the graphics, and the layout is pulled from the Modern Business theme. ."
sidebar: mydoc_sidebar
permalink: /mydoc_kb_layout/
toc: false
---
Here's the sample knowledge-base style layout:

View File

@ -56,8 +56,8 @@ The following table describes each of the frontmatter that you can use with this
| **last_updated** | Optional | The date the page was last updated. This information could helpful for readers trying to evaluate how current and authoritative information is. If included, the last_updated date appears in the footer of the page in rather small font.|
| **summary** | Optional | A 1-2 word sentence summarizing the content on the page. This gets formatted into the summary section in the page layout. Adding summaries is a key way to make your content more scannable by users (check out [Jakob Nielsen's site](http://www.nngroup.com/articles/corporate-blogs-front-page-structure/) for a great example of page summaries.) The only drawback with summaries is that you can't use variables in them. |
| **permalink**| Required | This theme uses permalinks to facilitate the linking. You specify the permalink want for the page, and the \_site output will put the page into the root directory when you publish. The page will appear inside a folder by the same name, with the actual page being index.html. Browsers will automatically show the index.html file inside of any folder, so permalinks avoid the .html extension with file names. Permalink names don't have to match your file names, but it might be easier to keep them in sync. If you don't use permalinks, Jekyll automatically uses the file name and folder path as the link.|
| **datatable** | Optional | 'active'. If you add `datatable: active` in the frontmatter, scripts for the [jQuery Datatables plugin](https://www.datatables.net/) get included on the page. You can see the scripts that conditionally appear by looking in the \_layouts/default.html page. |
| toc | Optional | If you specify `toc: none` in the frontmatter, the page won't have the table of contents that appears below the title. The toc refers to the list of jump links below the page title, not the sidebar navigation. You probably want to hide the TOC on the homepage and product landing pages.|
| **datatable** | Optional | 'true'. If you add `datatable: true` in the frontmatter, scripts for the [jQuery Datatables plugin](https://www.datatables.net/) get included on the page. You can see the scripts that conditionally appear by looking in the \_layouts/default.html page. |
| toc | Optional | If you specify `toc: false` in the frontmatter, the page won't have the table of contents that appears below the title. The toc refers to the list of jump links below the page title, not the sidebar navigation. You probably want to hide the TOC on the homepage and product landing pages.|
## Colons in page titles
@ -109,7 +109,7 @@ kramdown:
## Automatic mini-TOCs
By default, a TOC appears at the top of your pages and posts. If you don't want the TOC to appear for a specific page, such as for a landing page or other homepage, add `toc: none` in the frontmatter of the page.
By default, a TOC appears at the top of your pages and posts. If you don't want the TOC to appear for a specific page, such as for a landing page or other homepage, add `toc: false` in the frontmatter of the page.
The mini-TOC requires you to use the `##` Markdown syntax for headings. If you use `<h2>` elements, you must add an ID attribute for the heading element in order for it to appear in the mini-TOC (for example, `<h2 id="mysampleid">Heading</h2>`.

View File

@ -3,7 +3,7 @@ title: Tables
tags: [formatting]
keywords: datatables, tables, grids, markdown, multimarkdown, jquery plugins
last_updated: March 20, 2016
datatable: active
datatable: true
summary: "You can format tables using either multimarkdown syntax or HTML. You can also use jQuery datatables (a plugin) if you need more robust tables."
sidebar: mydoc_sidebar
permalink: /mydoc_tables/

View File

@ -3,7 +3,7 @@ title: News
sidebar: home_sidebar
keywords: news, blog, updates, release notes, announcements
permalink: /news/
toc: none
toc: false
---
<div class="home">

View File

@ -3,7 +3,7 @@ title: News
sidebar: tags_sidebar
keywords: news, blog, updates, release notes, announcements
permalink: /news_archive/
toc: none
toc: false
---
<div class="home">

View File

@ -2,7 +2,7 @@
title: Product 1
keywords: mydoc
sidebar: product1_sidebar
toc: none
toc: false
permalink: /p1_landing_page/
---
<div class="row">

View File

@ -2,7 +2,7 @@
title: Product 2
keywords: mydoc
sidebar: product2_sidebar
toc: none
toc: false
permalink: /p2_landing_page/
---
<div class="row">

View File

@ -112,7 +112,7 @@ search: exclude
|_|
{% endcomment %}
{% for entry in topnav %}
{% for entry in site.data.topnav.topnav %}
{% for subcategory in entry.subcategories %}
{% unless subcategory.external_url %}
{{subcategory.url | replace: "/", ""| replace: "\", ""}}:
@ -123,7 +123,7 @@ search: exclude
{% endfor %}
{% endfor %}
{% for entry in topnav_dropdowns %}
{% for entry in site.data.topnav.topnav_dropdowns %}
{% for subcategory in entry.subcategories %}
{% for subitem in subcategory.items %}
{% unless subitem.external_url %}