From 50a7f97a628bd94c99033184eb743078c904503f Mon Sep 17 00:00:00 2001 From: spf13 Date: Tue, 21 Jan 2014 20:05:26 -0500 Subject: [PATCH] Updating page variable documentation (for templates). --- docs/content/layout/variables.md | 32 ++++++++++++++++++++++++-------- 1 file changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/content/layout/variables.md b/docs/content/layout/variables.md index 5aa94b7e5..e2424a5b7 100644 --- a/docs/content/layout/variables.md +++ b/docs/content/layout/variables.md @@ -11,27 +11,43 @@ are available in the context for the templates. ## Page Variables +The following is a list of most of the accessible variables which can be +defined for a piece of content. Many of these will be defined in the front +matter, content or derived from file location. + **.Title** The title for the content.
+**.Content** The content itself, defined below the front matter.
+**.Summary** A generated summary of the content for easily showing a snippet in a summary view.
**.Description** The description for the content.
**.Keywords** The meta keywords for this content.
**.Date** The date the content is published on.
-**.Indexes** These will use the field name of the plural form of the index (see tags and categories above)
+**.Type** The content [type](/content/types/) (eg. post)
+**.Section** The [section](/content/sections/) this content belongs to
**.Permalink** The Permanent link for this page.
**.RelPermalink** The Relative permanent link for this page.
**.LinkTitle** Access when creating links to this content. Will use linktitle if set in front-matter, else title
-**.FuzzyWordCount** The approximate number of words in the content.
+**.Indexes** These will use the field name of the plural form of the index (see tags and categories above)
**.RSSLink** Link to the indexes' rss link
**.Prev** Pointer to the previous content (based on pub date)
**.Next** Pointer to the following content (based on pub date)
+**.FuzzyWordCount** The approximate number of words in the content.
+**.WordCount** The number of words in the content.
+**.ReadingTime** The estimated time it takes to read the content in minutes.
+**.Weight** Assigned weight (in the front matter) to this content, used in sorting.
**.Site** See site variables below
-**.Content** The content itself, defined below the front matter.
-**.Summary** A generated summary of the content for easily showing a snippet in a summary view.
-Any value defined in the front matter, including indexes will be made available under `.Params`. +<<<<<<< HEAD +## Page Params + +======= +>>>>>>> fab475f... Updating page variable documentation (for templates). +Any other value defined in the front matter, including indexes will be made available under `.Params`. Take for example I'm using tags and categories as my indexes. The following would be how I would access them: -**.Params.Tags**
-**.Params.Categories**
+**.Params.tags**
+**.Params.categories**
+
+**All Params are only accessible using all lowercase characters**
## Node Variables In Hugo a node is any page not rendered directly by a content file. This @@ -39,10 +55,10 @@ includes indexes, lists and the homepage. **.Title** The title for the content.
**.Date** The date the content is published on.
-**.Data** The data specific to this type of node.
**.Permalink** The Permanent link for this node
**.Url** The relative url for this node.
**.RSSLink** Link to the indexes' rss link
+**.Data** The data specific to this type of node.
**.Site** See site variables below
## Site Variables