You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by cp...@apache.org on 2017/05/25 17:36:48 UTC
[43/59] [abbrv] lucene-solr:jira/solr-8668: Ref Guide: add a bit more
info to TOC options in meta-docs
Ref Guide: add a bit more info to TOC options in meta-docs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/b179249c
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/b179249c
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/b179249c
Branch: refs/heads/jira/solr-8668
Commit: b179249ce0c5b56442ba54f941660f5d4129d46c
Parents: fa76171
Author: Cassandra Targett <ca...@lucidworks.com>
Authored: Fri May 19 14:34:00 2017 -0500
Committer: Cassandra Targett <ca...@lucidworks.com>
Committed: Fri May 19 14:34:00 2017 -0500
----------------------------------------------------------------------
solr/solr-ref-guide/meta-docs/jekyll.adoc | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/b179249c/solr/solr-ref-guide/meta-docs/jekyll.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/meta-docs/jekyll.adoc b/solr/solr-ref-guide/meta-docs/jekyll.adoc
index 8d3f2fc..d00b487 100644
--- a/solr/solr-ref-guide/meta-docs/jekyll.adoc
+++ b/solr/solr-ref-guide/meta-docs/jekyll.adoc
@@ -40,11 +40,11 @@ The Solr Ref Guide uses the front matter to define some custom attributes on a p
There are also some optional custom attributes that can be defined in pages to affect the Table of Contents presentation in jekyll:
-* `page-toclevels` - changes how "deep" the TOC will be in terms of nested section/sub-section titles (default = 2
-* `page-tocclass` - changes the CSS class applied to the TOC, default = "normal", resulting in the class name `toc-normal`
+* `page-toclevels` - changes how "deep" the TOC will be in terms of nested section/sub-section titles (default = 2)
+* `page-tocclass` - changes the CSS class applied to the TOC, default = "normal", resulting in the class name `toc-normal`. The other option is "right", to put the TOC on the right side of the page.
* `page-toc` - if this is false, then no TOCs will be generated for the page at all.
-NOTE: The special macro `{section-toc}` can be used anywhere in a page to create an "In this Section" TOC covering only the sub-headings in the same secion. `:page-toc: false` will also prevent this macro from working, so if you want no "top level" TOC, but you do want section TOCs, use `:page-toclevels: 0`
+NOTE: The special macro `{section-toc}` can be used anywhere in a page to create an "In this Section" TOC covering only the sub-headings in the same section. `:page-toc: false` will also prevent this macro from working, so if you want no "top level" TOC, but you do want section TOCs, use `:page-toclevels: 0`
=== Layouts