From e19638e49804789b4ebe449ca3941ce52a77921c Mon Sep 17 00:00:00 2001 From: Tom Johnson Date: Wed, 12 Aug 2015 18:45:08 -0700 Subject: [PATCH] content updates --- _data/sidebar_doc.yml | 7 +++++++ _data/tags_doc.yml | 2 +- doc_about.md | 13 ++++++------- doc_adding_tooltips.md | 8 ++++---- doc_alerts.md | 10 +++++----- doc_build_arguments.md | 7 +++---- doc_collections.md | 9 ++++----- doc_conditional_logic.md | 10 ++++++---- doc_configuration_settings.md | 7 ++++--- doc_content_reuse.md | 10 +++++----- doc_excluding_files.md | 10 +++++----- doc_faq.html | 9 ++++----- doc_generating_pdfs.md | 11 +++++------ doc_getting_started.md | 9 ++++----- doc_glossary.md | 9 ++++----- doc_help_api.md | 15 +++++++-------- doc_hyperlinks.md | 6 ++++-- doc_icons.md | 10 +++++----- doc_images.md | 9 ++++----- doc_iterm_profiles.md | 9 +++++---- doc_kb_layout.md | 14 ++++---------- doc_labels.md | 12 ++++++------ doc_navtabs.md | 9 ++++----- doc_pages.md | 12 ++++++------ doc_push_build_to_server.md | 3 ++- doc_scroll.html | 6 +++--- doc_search_configuration.md | 10 +++++----- doc_series.md | 8 ++++---- doc_seriesdemo1_0.md | 1 + doc_seriesdemo1_1.md | 1 + doc_seriesdemo1_2.md | 1 + doc_seriesdemo1_3.md | 1 + doc_shuffle.html | 10 ++++------ doc_sidebar_navigation.md | 5 ++--- doc_special_layouts.md | 15 +++++++-------- doc_support.md | 7 +++---- doc_supported_features.md | 7 +++---- doc_syntax_highlighting.md | 10 +++++----- doc_tables.md | 5 +++-- doc_tag-content-types.html | 6 ++++++ doc_tag_archives_overview.md | 5 ++++- doc_tags.md | 4 +++- doc_theme_customization.md | 7 +++---- doc_themes.md | 7 +++---- doc_top_navigation.md | 5 ++--- doc_troubleshooting.md | 7 +++---- doc_video_embeds.md | 7 +++---- doc_webstorm_text_editor.md | 3 +++ 48 files changed, 187 insertions(+), 181 deletions(-) create mode 100644 doc_tag-content-types.html diff --git a/_data/sidebar_doc.yml b/_data/sidebar_doc.yml index 298bf2a..2087e38 100644 --- a/_data/sidebar_doc.yml +++ b/_data/sidebar_doc.yml @@ -384,6 +384,13 @@ entries: version: all product: all + - title: Content types pages + url: /doc_tag-content-types.html + audience: writers, designers + platform: all + version: all + product: all + - title: Publishing pages url: /doc_tag-publishing.html audience: writers, designers diff --git a/_data/tags_doc.yml b/_data/tags_doc.yml index ea7e068..b7bee2b 100644 --- a/_data/tags_doc.yml +++ b/_data/tags_doc.yml @@ -1,9 +1,9 @@ allowed-tags: - getting-started + - content-types - navigation - formatting - publishing - single-sourcing - special-layouts - - content types diff --git a/doc_about.md b/doc_about.md index 3fef893..375305a 100644 --- a/doc_about.md +++ b/doc_about.md @@ -1,10 +1,9 @@ --- title: About this theme -tags: [] -keywords: -audience: writer, designer -last_updated: -summary: +keywords: documentation theme, jekyll, technical writers, help authoring tools, hat replacements +last_updated: August 12, 2015 +tags: [getting-started] +summary: "I use this theme for sophisticated single-sourcing projects that I work on as a professional technical writer." --- {% include linkrefs.html %} @@ -12,9 +11,9 @@ My name is Tom Johnson, and I'm a technical writer, blogger, and podcaster based I'm using this theme for my documentation projects. This theme has undergone several major iterations, and now it's fairly stable and full of all the features that I need. You are welcome to use it for your documentation projects for free. -I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. +I think this theme does pretty much everything that you can do with something like OxygenXML, but without the constraints of structured authoring. Everything is completely open and changeable, so if you start tinkering around with the theme's files, you can break things. But it's completely empowering as well! -By having a completely open architecture and code, there are more points of risk. At the same time, it's much easier to modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code. +With a completely open architecture and code base, you can modify the code to make it do exactly what you want, without having to jump through all kinds of confusing or proprietary code. If there's a feature you need but it isn't available here, let me know and I might add it. Alternatively, if you fork the theme, I would love to see your modifications and enhancements. diff --git a/doc_adding_tooltips.md b/doc_adding_tooltips.md index dd394d4..486fc68 100644 --- a/doc_adding_tooltips.md +++ b/doc_adding_tooltips.md @@ -1,13 +1,13 @@ --- title: Tooltips tags: [formatting] -keywords: popovers -audience: writers, designers -last_updated: May 13, 2015 -summary: "You can add tooltips to your content. These tooltips work well for glossary definitions." +keywords: popovers, tooltips, user interface text, glossaries, definitions +last_updated: August 12, 2015 +summary: "You can add tooltips to any word, such as an acronym or specialized term. Tooltips work well for glossary definitions, because you don't have to keep repeating the definition, nor do you assume the reader already knows the word's meaning." --- {% include linkrefs.html %} +## Creating tooltips Because this theme is built on Bootstrap, you can simply use a specific attribute on an element to insert a tooltip. Suppose you have a glossary.yml file inside your \_data folder. You could pull in that glossary definition like this: diff --git a/doc_alerts.md b/doc_alerts.md index 6162c6c..50076ad 100644 --- a/doc_alerts.md +++ b/doc_alerts.md @@ -1,13 +1,13 @@ --- title: Alerts -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting] +keywords: notes, tips, cautions, warnings, admonitions +last_updated: August 12, 2015 +summary: "You can insert notes, tips, warnings, and important alerts in your content. These notes are stored as shortcodes made available through the linksrefs.hmtl include." --- {% include linkrefs.html %} +## About alerts Alerts are little warnings, info, or other messages that you have called out in special formatting. In order to use these alerts or callouts, put this include at the top of your page, just below your frontmatter: {%raw%} diff --git a/doc_build_arguments.md b/doc_build_arguments.md index 6114278..1252691 100644 --- a/doc_build_arguments.md +++ b/doc_build_arguments.md @@ -1,10 +1,9 @@ --- title: Build arguments tags: [publishing] -audience: writer, designer -keywords: -last_updated: -summary: +keywords: building, serving, serve, build +last_updated: August 12, 2015 +summary: "When you have a single sourcing project, you use more advanced arguments when you're building or serving your Jekyll sites. These arguments specify a particular configuration file and may build on other configuration files." --- {% include linkrefs.html %} diff --git a/doc_collections.md b/doc_collections.md index e4e5f81..66ac86e 100644 --- a/doc_collections.md +++ b/doc_collections.md @@ -1,10 +1,9 @@ --- title: Collections -tags: [] -keywords: -audience: -last_updated: -summary: +tags: [content-types] +keywords: groups, api, structure +last_updated: August 12, 2015 +summary: "Collections are useful if you want to loop through a special folder of pages that you make available in a content API. You could also use collections if you have a set of articles that you want to treat differently from the other content, with a different layout or format." --- {% include linkrefs.html %} diff --git a/doc_conditional_logic.md b/doc_conditional_logic.md index 0d10799..8cd7658 100644 --- a/doc_conditional_logic.md +++ b/doc_conditional_logic.md @@ -1,15 +1,17 @@ --- title: Conditional logic tags: [single-sourcing] -audience: writer, designer -keywords: -last_updated: -summary: +keywords: if else logic, conditions, conditional attributes, conditional filtering +last_updated: August 12, 2015 +summary: "You can implement advanced conditional logic that includes if statements, or statements, unless, and more. This conditional logic facilitates single sourcing scenarios in which you're outputting the same content for different audiences." --- {% include linkrefs.html %} +## About Liquid and conditional statements If you want to create different outputs for different audiences, you can do all of this using a combination of Jekyll's Liquid markup and values in your configuration file. +You can then incorporate conditional statements that check the values in the configuration files. + {{tip}} Definitely check out Liquid's documentation for more details about how to use operators and other liquid markup. The notes here are a small, somewhat superficial sample from the site.{{end}} ## Where to store filtering values diff --git a/doc_configuration_settings.md b/doc_configuration_settings.md index b552b4a..4922360 100644 --- a/doc_configuration_settings.md +++ b/doc_configuration_settings.md @@ -1,8 +1,9 @@ --- title: Configuration settings -tags: [] -keywords: -summary: "The configuration file contains important settings for your project. Some of the values you set here affect the display and functionality of the theme." +tags: [single-sourcing, publishing] +keywords: configuration, config, publishing options, outputs, projects +last_updated: August 12, 2015 +summary: "The configuration file contains important settings for your project. Some of the values you set here affect — especially the product, platform, audience, and version — the display and functionality of the theme." --- {% include linkrefs.html %} diff --git a/doc_content_reuse.md b/doc_content_reuse.md index 9e9e52c..84f56b8 100644 --- a/doc_content_reuse.md +++ b/doc_content_reuse.md @@ -1,13 +1,13 @@ --- title: Content reuse -tags: single-sourcing -audience: writer, designer -keywords: -last_updated: -summary: +tags: [single-sourcing] +keywords: includes, conref, dita, transclusion, transclude, inclusion, reference +last_updated: August 12, 2015 +summary: "You can reuse chunks of content by storing these files in the includes folder. You then choose to include the file where you need it. This works similar to conref in DITA, except that you can include the file in any content type." --- {% include linkrefs.html %} +## About content reuse You can embed content from one file inside another using includes. Put the file containing content you want to reuse (e.g., mypage.html) inside the \_includes folder, and then use a tag like this: {% raw %} diff --git a/doc_excluding_files.md b/doc_excluding_files.md index 369fbcd..77d070c 100644 --- a/doc_excluding_files.md +++ b/doc_excluding_files.md @@ -1,13 +1,13 @@ --- title: Excluding files -tags: single-sourcing -audience: writer, designer -keywords: -last_updated: -summary: +tags: [single-sourcing] +last_updated: August 12, 2015 +keywords: exclusion, separating outputs, removing files from outputs +summary: "By default, all the files in your Jekyll project are included in the output (this differs from DITA projects, which don't include files unless noted on the map). If you're single sourcing, you'll need to exclude the files that shouldn't be included in the output. The sidebar doesn't control inclusion or exclusion." --- {% include linkrefs.html %} +## About exclusion By default, all files in your project are included in your output (regardless of whether they're listed in the sidebar_doc.yml file or not). To exclude files, note them in the `exclude` section in the configuration file. Here's a sample: ``` diff --git a/doc_faq.html b/doc_faq.html index 447b661..21e8277 100644 --- a/doc_faq.html +++ b/doc_faq.html @@ -1,10 +1,9 @@ --- title: FAQ -tags: special-layouts -audience: writer, designer -audience: -last_updated: -summary: +tags: [special-layouts] +keywords: frequently asked questions, FAQ, question and answer, collapsible sections, expand, collapse +last_updated: August 12, 2015 +summary: "You can use an accordion-layout that takes advantage of Bootstrap styling. This is useful for an FAQ page." --- {% include linkrefs.html %} diff --git a/doc_generating_pdfs.md b/doc_generating_pdfs.md index e16bc47..57f806c 100644 --- a/doc_generating_pdfs.md +++ b/doc_generating_pdfs.md @@ -1,14 +1,13 @@ --- title: Generating PDF -tags: publishing -keywords: -audience: -last_updated: -summary: +tags: [publishing, single-sourcing, content-types] +keywords: PDF, prince, prince XML, ant, xsl fo +last_updated: August 12, 2015 +summary: "You can generate a PDF from your Jekyll project. You do this by creating a web version of your project that is printer friendly. You then use utility called Prince to iterate through the pages and create a PDF from them. It works quite well and gives you complete control to customize the PDF output through CSS, including page directives and dynamic tags from Prince." --- {% include linkrefs.html %} -## Overview +## PDF overview This process for creating a PDF relies on Prince XML to transform the HTML content into PDF. Prince costs about $500 per license. That might seem like a lot, but if you're creating a PDF, you're probably working for a company that sells a product, so you likely have access to some resources. The basic approach is to generate a list of all pages that need to be added to the PDF, and then add leverage Prince to package them up into a PDF. diff --git a/doc_getting_started.md b/doc_getting_started.md index f38142d..b5cb46e 100644 --- a/doc_getting_started.md +++ b/doc_getting_started.md @@ -1,10 +1,9 @@ --- title: Getting started with this theme -tags: getting-started -audience: writer, designer -keywords: -last_updated: -summary: +tags: [getting-started] +keywords: start, introduction, begin, install, build, hello world, +last_updated: August 12, 2015 +summary: "To get started with this theme, first make sure you have all the prerequisites in place; then build the theme following the sample build commands. Because this theme is set up for single sourcing projects, it doesn't follow the same pattern as most Jekyll projects (which have just a _config.yml file in the root directory)." --- {% include linkrefs.html %} diff --git a/doc_glossary.md b/doc_glossary.md index 5fe27d2..e07d548 100644 --- a/doc_glossary.md +++ b/doc_glossary.md @@ -1,10 +1,9 @@ --- title: Glossaries -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting, special-layouts] +keywords: definitions, glossaries, terms, style guide +last_updated: August 12, 2015 +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." --- {% include linkrefs.html %} diff --git a/doc_help_api.md b/doc_help_api.md index f143bad..1dea8a9 100644 --- a/doc_help_api.md +++ b/doc_help_api.md @@ -1,16 +1,15 @@ --- title: Help APIs and UI tooltips -tags: publishing -audience: writer, designer -keywords: -last_updated: -summary: +tags: [publishing, single-sourcing, content-types] +last_updated: August 12, 2015 +keywords: API, content API, UI text, inline help, context-sensitive help, popovers, tooltips +summary: "You can loop through files and generate a JSON file that developers can consume like a help API. Developers can pull in values from the JSON into interface elements, styling them as popovers for user interface text. The beauty of this method is that the UI text remains in the help system and isn't hard-coded into the UI." --- -{% include linkrefs.html %} +{% include linkrefs.html %} -You can create a help API that developers can use to pull in content. +## Full code demo of content API -## Full code demo +You can create a help API that developers can use to pull in content. For the full code demo, see the notes in the Tooltip Demo. diff --git a/doc_hyperlinks.md b/doc_hyperlinks.md index efdd04f..d0c5a0a 100644 --- a/doc_hyperlinks.md +++ b/doc_hyperlinks.md @@ -2,11 +2,13 @@ title: Links audience: writer, designer tags: [formatting, navigation] -summary: +keywords: links, hyperlinks, cross references, related links, relationship tables +summary: "When creating links, although you can use standard HTML or Markdown, a better way to handle links is to store them as captured variables in an include file, and then reference the capture keywords for the links. This way you can update titles in one place, more easily identify broken links, and better manage your links. This approach is simliar to the keyref-style links in DITA." +last_updated: August 12, 2015 --- {% include linkrefs.html %} -## Link strategy +## Link strategies One of the more difficult parts of a documentation site is keeping all the internal links accurate and valid. Although there are many ways to create links, I'll just describe what I've found to work well. diff --git a/doc_icons.md b/doc_icons.md index 1bcc09e..f5407e0 100644 --- a/doc_icons.md +++ b/doc_icons.md @@ -1,13 +1,13 @@ --- title: Icons -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting] +keywords: font icons, buttons, images, vectors, font awesome, glyphicons +last_updated: August 12, 2015 +summary: "You can integrate font icons through the Font Awesome and Glyphical Halflings libraries. These libraries allow you to embed icons through their libraries delivered as a link reference. You don't need any image libraries downloaded in your project." --- {% include linkrefs.html %} +## Font icon options The theme has two font icon sets integrated: Font Awesome and Glyphicons Halflings. The latter is part of Bootstrap, while the former is independent. Font icons allow you to insert icons drawn as vectors from a CDN (so you don't have any local images on your own site). ## See Font Awesome icons available diff --git a/doc_images.md b/doc_images.md index 2eb5eda..e2b1617 100644 --- a/doc_images.md +++ b/doc_images.md @@ -1,10 +1,9 @@ --- title: Images -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting] +keywords: images, screenshots, vectors, svg, markdown syntax +last_updated: August 12, 2015 +summary: "You embed images using traditional HTML or Markdown syntax for images. Unlike pages, you can store images in subfolders (in this theme). This is because when pages reference the images, the references are always as subpaths, never requiring the reference to move up directories." --- {% include linkrefs.html %} diff --git a/doc_iterm_profiles.md b/doc_iterm_profiles.md index fb10709..993f77c 100644 --- a/doc_iterm_profiles.md +++ b/doc_iterm_profiles.md @@ -1,13 +1,14 @@ --- title: iTerm profiles tags: [publishing] -keywords: -audience: -last_updated: May 13, 2015 -summary: "Set up profiles in iTerm to facilitate the build process. This can make it a lot easier to quickly build multiple outputs." +keywords: iterm, terminal, build shortcuts, mac +last_updated: August 12, 2015 +summary: "Set up profiles in iTerm to facilitate the build process with just a few clicks. This can make it a lot easier to quickly build multiple outputs." --- {% include linkrefs.html %} +## About iTerm profiles + When you're working with tech docs, a lot of times you're single sourcing multiple outputs. It can be a hassle to fire up each one of these outputs using the build files containing the shell scripts. Instead, it's easier to configure iTerm with profiles that initiate the scripts. ## Set up profiles diff --git a/doc_kb_layout.md b/doc_kb_layout.md index 2b2919d..5dbac13 100644 --- a/doc_kb_layout.md +++ b/doc_kb_layout.md @@ -1,16 +1,12 @@ --- title: Knowledge-base layout -tags: special-layouts -keywords: -audience: -last_updated: -summary: -metadata: false +tags: [special-layouts] +keywords: knowledge base, support portal, grid, doc portal +last_updated: August 12, 2015 +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 enlarged to a large size. You can also add captions below each icon." --- {% include linkrefs.html %} -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 enlarged to a large size. You can also add captions below each icon. -
Getting Started
Navigation
@@ -23,8 +19,6 @@ This shows a sample layout for a knowledge base. Each square could link to a tag
Formatting
- - ## Generating a list of all pages with a certain tag If you don't want to link to a tag archive index, but instead want to list all pages that have a certain tag, you could use this code: diff --git a/doc_labels.md b/doc_labels.md index f09d679..ac87863 100644 --- a/doc_labels.md +++ b/doc_labels.md @@ -1,14 +1,14 @@ --- title: Labels -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting] +keywords: labels, buttons, bootstrap, api methods +last_updated: August 12, 2015 +summary: "Labels are just a simple Bootstrap component that you can include in your pages as needed. They represent one of many Bootstrap options you can include in your theme." --- {% include linkrefs.html %} -These labels might come in handy for labeling things, such as POST, DELETE, UPDATE methods for endpoints. You can use any classes from Bootstrap in your content. +## About labels +Labels might come in handy for adding button-like tags next to elements, such as POST, DELETE, UPDATE methods for endpoints. You can use any classes from Bootstrap in your content. ```html Default diff --git a/doc_navtabs.md b/doc_navtabs.md index ff48afb..2fc56d8 100644 --- a/doc_navtabs.md +++ b/doc_navtabs.md @@ -1,10 +1,9 @@ --- title: NavTabs -tags: [] -keywords: -audience: -last_updated: -summary: "Navtabs provide a tabbable navagation directly in your content. Navtabs are helpful for showing code samples for different programming languages." +tags: [formatting] +keywords: navigation tabs, hide sections, tabbers, interface tabs +last_updated: August 12, 2015 +summary: "Navtabs provide a tab-based navagation directly in your content, allowing users to click from tab to tab to see different panels of content. Navtabs are especially helpful for showing code samples for different programming languages. The only downside to using navtabs is that you must use HTML instead of Markdown." --- {% include linkrefs.html %} diff --git a/doc_pages.md b/doc_pages.md index 1f8a437..c6d29ff 100644 --- a/doc_pages.md +++ b/doc_pages.md @@ -1,10 +1,9 @@ --- title: Pages -audience: writer, designer -tags: [getting-started, formatting] -keywords: -last_updated: -summary: +tags: [getting-started, formatting, content-types] +keywords: pages, authoring, exclusion, frontmatter +last_updated: August 12, 2015 +summary: "This theme uses pages only, not posts. You need to make sure your pages have the appropriate frontmatter. One frontmatter tag your users might find helpful is the summary tag. This functions similar in purpose to the shortdesc element in DITA." --- {% include linkrefs.html %} @@ -35,8 +34,9 @@ Make sure each page has frontmatter at the top like this: {% raw %} --- title: Your page title -tags: [deployment] +tags: [formatting, getting-started] keywords: overview, going live, high-level +last_updated: August 12, 2015 summary: "Deploying DeviceInsight requires the following steps." {% endraw %} --- diff --git a/doc_push_build_to_server.md b/doc_push_build_to_server.md index 5d4f01d..e47a7a6 100644 --- a/doc_push_build_to_server.md +++ b/doc_push_build_to_server.md @@ -2,7 +2,8 @@ title: Pushing builds to server tags: [publishing] keywords: AWS, Amazon, command line, pushing build -summary: "You can push your build to AWS using commands from the command line." +last_updated: August 12, 2015 +summary: "You can push your build to AWS using commands from the command line. By including your copy commands in commands, you can package all of the build and deploy process into executable scripts." --- {% include linkrefs.html %} diff --git a/doc_scroll.html b/doc_scroll.html index 62fe2d0..dee2f3c 100644 --- a/doc_scroll.html +++ b/doc_scroll.html @@ -1,13 +1,13 @@ --- title: Scroll layout type: scroll -audience: writer, designer +keywords: json, scrolling, scrollto, jquery plugin tags: special-layouts +last_updated: August 12, 2015 +summary: "This page demonstrates how you the integration of a script called ScrollTo, which is used here to link definitions of a JSON code sample to a list of definitions for that particular term. The scenario here is that the JSON blocks are really long, with extensive nesting and subnesting, which makes it difficult for tables below the JSON to adequately explain the term in a usable way." --- {% include linkrefs.html %} -

This page demonstrates how you the integration of a script called ScrollTo, which is used here to link definitions of a JSON code sample to a list of definitions for that particular term. The scenario here is that the JSON blocks are really long, with extensive nesting and subnesting, which makes it difficult for tables below the JSON to adequately explain the term in a usable way.

- {% if site.print == true %} {{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}} {% endif %} diff --git a/doc_search_configuration.md b/doc_search_configuration.md index f4e6450..0e36928 100644 --- a/doc_search_configuration.md +++ b/doc_search_configuration.md @@ -1,13 +1,13 @@ --- title: Search configuration -audience: writer, designer -tags: publishing -keywords: -last_updated: -summary: +tags: [publishing, navigation] +keywords: search, json, configuration, findability +last_updated: August 12, 2015 +summary: "The search feature uses JavaScript to look for keyword matches in a JSON file. The results show instant matches, but it doesn't provide a search results page like Google. Also, sometimes invalid formatting can break the JSON file." --- {% include linkrefs.html %} +## About search The search is configured through the search.json file in the root directory. Take a look at that code if you want to change what fields are included. The search is a simple search that looks at content in pages. It looks at titles, summaries, keywords, tags, and bodies. diff --git a/doc_series.md b/doc_series.md index 1dcc40e..a472099 100644 --- a/doc_series.md +++ b/doc_series.md @@ -1,13 +1,13 @@ --- title: Series pages -tags: [] -keywords: series -audience: writers, designers -last_updated: May 17, 2015 +tags: [content-types] +keywords: series, connected articles, tutorials, hello world +last_updated: August 12, 2015 summary: "You can automatically link together topics belonging to the same series. This helps users know the context within a particular process." --- {% include linkrefs.html %} +## Using series for pages You create a series by looking for all pages within a tag namespace that contain certain frontmatter. Here's a demo: {{doc_seriesdemo1_1}}. ## 1. Create the series button diff --git a/doc_seriesdemo1_0.md b/doc_seriesdemo1_0.md index c42e94a..0964362 100644 --- a/doc_seriesdemo1_0.md +++ b/doc_seriesdemo1_0.md @@ -3,6 +3,7 @@ title: Series demo 1.0 summary: "This is the first post in the series." series: "ACME series" weight: 1.0 +last_updated: August 12, 2015 --- {% include linkrefs.html %} diff --git a/doc_seriesdemo1_1.md b/doc_seriesdemo1_1.md index b65b048..7d30c33 100644 --- a/doc_seriesdemo1_1.md +++ b/doc_seriesdemo1_1.md @@ -3,6 +3,7 @@ title: Series demo 1.1 summary: "This is the second post in the series." series: "ACME series" weight: 1.1 +last_updated: August 12, 2015 --- {% include linkrefs.html %} diff --git a/doc_seriesdemo1_2.md b/doc_seriesdemo1_2.md index 9e8283e..c55ec79 100644 --- a/doc_seriesdemo1_2.md +++ b/doc_seriesdemo1_2.md @@ -4,6 +4,7 @@ last_updated: May 17, 2015 summary: "This is the third post in the series." series: "ACME series" weight: 1.2 +last_updated: August 12, 2015 --- {% include linkrefs.html %} diff --git a/doc_seriesdemo1_3.md b/doc_seriesdemo1_3.md index fb8a57b..6c01c08 100644 --- a/doc_seriesdemo1_3.md +++ b/doc_seriesdemo1_3.md @@ -3,6 +3,7 @@ title: Series demo 1.3 summary: "This is the fourth post in the series." series: "ACME series" weight: 1.3 +last_updated: August 12, 2015 --- {% include linkrefs.html %} diff --git a/doc_shuffle.html b/doc_shuffle.html index 9791cd8..88b412b 100644 --- a/doc_shuffle.html +++ b/doc_shuffle.html @@ -1,14 +1,12 @@ --- title: Shuffle layout -tags: special-layouts -type: noTags -keywords: -summary: +tags: [special-layouts] +last_updated: August 12, 2015 +keywords: shuffle, card layout, dynamic grid, doc portal, support portal +summary: "This layout shows an example of a knowledge-base style navigation system, where there is no hierarchy, just groups of pages that have certain tags." --- {% include linkrefs.html %} -This layout shows an example of a knowledge-base style navigation system, where there is no hierarchy, just groups of pages that have certain tags. - {% if site.print == true %} {{note}} The content on this page doesn't display well on PDF, but I included it anyway so you could see the problems this layout poses if you're including it in PDF. {{end}} {% endif %} diff --git a/doc_sidebar_navigation.md b/doc_sidebar_navigation.md index c54f57b..6354d6c 100644 --- a/doc_sidebar_navigation.md +++ b/doc_sidebar_navigation.md @@ -1,9 +1,8 @@ --- title: Sidebar navigation -audience: writer, designer tags: [navigation] -keywords: -last_updated: +keywords: sidebar, toc, table of contents, navigation +last_updated: August 12, 2015 summary: "The sidebar and top navigation bar read their values from yml files. The navigation components are one of the most unique parts of this theme, since the navigation components are only included if they meet all of the product, audience, version, etc., values as specified in the project settings." --- {% include linkrefs.html %} diff --git a/doc_special_layouts.md b/doc_special_layouts.md index a5e3f60..a4ac4ac 100644 --- a/doc_special_layouts.md +++ b/doc_special_layouts.md @@ -1,14 +1,13 @@ --- -title: Special layouts -tags: special-layouts -keywords: -audience: writer, designer -last_updated: -summary: +title: Special layouts overview +tags: [special-layouts] +keywords: layouts, information design, presentation +last_updated: August 12, 2015 +summary: "This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site." --- -{% include linkrefs.html %} +{% include linkrefs.html %} -This theme has a few special layouts. Special layouts include the JS files they need directly in the page. The JavaScript for each special layout does not load by default for every page in the site. +{{note}} By "layout," I'm not referring to the layouts in \_layouts in the project files. I'm referring to special ways of presenting information on the same "page" layout. {{end}} ## FAQ layout diff --git a/doc_support.md b/doc_support.md index ee97879..ac503f5 100644 --- a/doc_support.md +++ b/doc_support.md @@ -1,10 +1,9 @@ --- title: Support -audience: writer, designer tags: [getting-started] -keywords: -last_updated: -summary: +keywords: questions, troubleshooting, contact, support +last_updated: August 12, 2015 +summary: "Contact me for any support issues." --- {% include linkrefs.html %} diff --git a/doc_supported_features.md b/doc_supported_features.md index 10b10b3..ae57797 100644 --- a/doc_supported_features.md +++ b/doc_supported_features.md @@ -1,10 +1,9 @@ --- title: Supported features -audience: writer, designer tags: [getting-started] -keywords: -last_updated: -summary: +keywords: features, capabilities, scalability, multichannel output, dita, hats, comparison, benefits +last_updated: August 12, 2015 +summary: "If you're not sure whether Jekyll and this theme will support your requirements, this list provides a semi-comprehensive overview of available features." --- {% include linkrefs.html %} diff --git a/doc_syntax_highlighting.md b/doc_syntax_highlighting.md index 84ba33f..d067794 100644 --- a/doc_syntax_highlighting.md +++ b/doc_syntax_highlighting.md @@ -1,13 +1,13 @@ --- title: Syntax highlighting -audience: writer, designer -tags: formatting -keywords: -last_updated: -summary: +tags: [formatting] +keywords: rouge, pygments, prettify, color coding, +last_updated: August 12, 2015 +summary: "You can apply syntax highlighting to your code. This theme uses pygments and applies color coding based on the lexer you specify." --- {% include linkrefs.html %} +## About syntax highlighting For syntax highlighting, use fenced code blocks optionally followed by the language syntax you want: 
diff --git a/doc_tables.md b/doc_tables.md
index c5df2d5..dd2050d 100644
--- a/doc_tables.md
+++ b/doc_tables.md
@@ -1,9 +1,10 @@
 ---
 title: Tables
 tags: [formatting]
-keywords:
+keywords: datatables, tables, grids, markdown, multimarkdown, jquery plugins
+last_updated: August 12, 2015
 datatable: true
-summary: 
+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."
 ---
 {% include linkrefs.html %}
 
diff --git a/doc_tag-content-types.html b/doc_tag-content-types.html
new file mode 100644
index 0000000..9948806
--- /dev/null
+++ b/doc_tag-content-types.html
@@ -0,0 +1,6 @@
+---
+title: "Content Types pages"
+tagName: content-types
+search: exclude
+---
+{% include taglogic.html %}
\ No newline at end of file
diff --git a/doc_tag_archives_overview.md b/doc_tag_archives_overview.md
index 675a6a8..bc693d7 100644
--- a/doc_tag_archives_overview.md
+++ b/doc_tag_archives_overview.md
@@ -1,6 +1,9 @@
 ---
 title: Tag archives overview
-keywords: tags
+keywords: archives, tagging
+last_updated: August 12, 2015
+tags: [navigation]
+summary:
 ---
 
 This is an overview to the tag archives section. Really the only reason this section is listed explicitly in the TOC here is to demonstrate how to add a third-level to the navigation.
\ No newline at end of file
diff --git a/doc_tags.md b/doc_tags.md
index de813eb..949176f 100644
--- a/doc_tags.md
+++ b/doc_tags.md
@@ -2,7 +2,9 @@
 title: Tags
 audience: writer, designer
 tags: [navigation]
-summary: 
+last_updated: August 12, 2015
+keywords: tags, navigation, buttons, links, association
+summary: "Tags provide another means of navigation for your content. Unlike the table of contents, tags can show the content in a variety of arrangements and groupings. Implementing tags in this Jekyll theme is somewhat of a manual process."
 ---
 {% include linkrefs.html %} 
 
diff --git a/doc_theme_customization.md b/doc_theme_customization.md
index eef277d..6fe1644 100644
--- a/doc_theme_customization.md
+++ b/doc_theme_customization.md
@@ -1,9 +1,8 @@
 ---
 title: Theme customization
-tags: getting-started
-audience: writer, designer
-keywords: 
-last_updated: 
+tags: [getting-started]
+last_updated: August 12, 2015
+keywords: getting started, customization, beginning steps, modifying the theme, modification
 summary: 
 ---
 {% include linkrefs.html %} 
diff --git a/doc_themes.md b/doc_themes.md
index 29ed897..e215d5c 100644
--- a/doc_themes.md
+++ b/doc_themes.md
@@ -1,9 +1,8 @@
 ---
 title: Themes
-audience: writer, designer
-tags: publishing
-keywords: 
-last_updated: 
+tags: [publishing]
+keywords: themes, styles, colors, css
+last_updated: August 12, 2015
 summary: 
 ---
 {% include linkrefs.html %} 
diff --git a/doc_top_navigation.md b/doc_top_navigation.md
index 440d5a7..56c3e51 100644
--- a/doc_top_navigation.md
+++ b/doc_top_navigation.md
@@ -1,9 +1,8 @@
 ---
 title: Top navigation
-audience: writer, designer
 tags: [navigation]
-keywords:
-last_updated:
+keywords: bootstrap, lists, drop-down, drop down navigation, top nav bar, topnav
+last_updated: August 12, 2015
 summary: "The top navigation provides either single links or a drop-down menu. There are some other features, such as a feedback email, custom menu, and popout link."
 ---
 {% include linkrefs.html %}
diff --git a/doc_troubleshooting.md b/doc_troubleshooting.md
index 4853eb8..724d1b5 100644
--- a/doc_troubleshooting.md
+++ b/doc_troubleshooting.md
@@ -1,9 +1,8 @@
 ---
 title: Troubleshooting
-tags: []
-keywords: 
-audience: 
-last_updated: 
+tags: [getting-started]
+keywords: trouble, problems, support, error messages, problems, failure, error, #fail
+last_updated: August 12, 2015
 summary: 
 ---
 {% include linkrefs.html %} 
diff --git a/doc_video_embeds.md b/doc_video_embeds.md
index 6442f7e..2cef237 100644
--- a/doc_video_embeds.md
+++ b/doc_video_embeds.md
@@ -1,9 +1,8 @@
 ---
 title: Video embeds
-audience: writer, designer
-tags: formatting
-keywords: 
-last_updated: 
+tags: [formatting]
+keywords: videos, youtube, vimeo, video js, video wrapper, mp4, stream
+last_updated: August 12, 2015
 summary: 
 video: true
 ---
diff --git a/doc_webstorm_text_editor.md b/doc_webstorm_text_editor.md
index a7692da..6cc7fe1 100644
--- a/doc_webstorm_text_editor.md
+++ b/doc_webstorm_text_editor.md
@@ -1,5 +1,8 @@
 ---
 title: WebStorm Text editor
+keywords: webstorm, sublime, markdown, atom, gnome, notepad ++, textpad, bbedit
+tags: [getting-started]
+last_updated: August 12, 2015
 summary:
 ---