{{ .Title }} : spf13.com

- {{ .Content }} -

{{ . }} - {{ $title }}

- {{ .TableOfContents }} -

{{ $indexname }} -
- {{ $taxonomyname }} +
  - {{ $key }}

-### menu.html using a single index -It is more likely that you would want to use a single index for navigation. -In this example we are using the `groups` index for our menu. - - - - -### menu.html using a single index ordered by Popularity - - diff --git a/docs/content/taxonomies/lists.md b/docs/content/taxonomies/lists.md deleted file mode 100644 index 16a855c1..00000000 --- a/docs/content/taxonomies/lists.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -title: "Taxonomy Lists" -date: "2013-07-01" -aliases: ["/indexes/lists/","/doc/indexes/", "/extras/indexes"] -linktitle: "Lists" -weight: 40 -menu: - main: - parent: 'taxonomy' ---- - -An index list is a list of all the keys that are contained in the index. When a -template is present, this will be rendered at `/IndexPlural/` - -Hugo also supports creating pages that list your values for each index along -with the number of content items associated with the index key. These are -global pages, not attached to any specific content, but rather display the meta -data in aggregate. - -To have hugo create these list of indexes pages, simply create a template in -/layouts/indexes/ called indexes.html - -Hugo can order the meta data in two different ways. It can be ordered by the -number of content assigned to that key or alphabetically. - - -## Example indexes.html file (alphabetical) - - {{ template "chrome/header.html" . }} - {{ template "chrome/subheader.html" . }} - -

{{ $value.Name }} {{ $value.Count }}

- {{ template "chrome/footer.html" }} - -## Example indexes.html file (ordered) - - {{ template "chrome/header.html" . }} - {{ template "chrome/subheader.html" . }} - -

{{ $value.Name }} {{ $value.Count }}

- - {{ template "chrome/footer.html" }} - -## Variables available to list of indexes pages. - -**.Title** The title for the content.
-**.Date** The date the content is published on.
-**.Permalink** The Permanent link for this page.
-**.RSSLink** Link to the indexes' rss link.
-**.Data.Singular** The singular name of the index
-**.Data.Plural** The plural name of the index
-**.Data.Index** The Index itself
-**.Data.Index.Alphabetical** The Index alphabetized
-**.Data.Index.ByCount** The Index ordered by popularity
diff --git a/docs/content/taxonomies/ordering.md b/docs/content/taxonomies/ordering.md index eaa36936..632bd1dc 100644 --- a/docs/content/taxonomies/ordering.md +++ b/docs/content/taxonomies/ordering.md @@ -8,22 +8,24 @@ menu: main: identifier: "Ordering Taxonomies" parent: 'taxonomy' +prev: "/taxonomies/templates" +next: "/extras/aliases" --- Hugo provides the ability to both: - 1. Order the way the keys for an index are displayed - 2. Order the way indexed content appears + 1. Order the way the keys for an taxonomy are displayed + 2. Order the way taxonomyed content appears -## Ordering Indexes -Indexes can be ordered by either alphabetical key or by the number of content pieces assigned to that key. +## Ordering Taxonomies +Taxonomies can be ordered by either alphabetical key or by the number of content pieces assigned to that key. ### Order Alphabetically Example:

{{ $value.Name }} {{ $value.Count }}

@@ -32,26 +34,26 @@ Indexes can be ordered by either alphabetical key or by the number of content pi

{{ $value.Name }} {{ $value.Count }}

-[See Also Index Lists](/indexes/lists/) +[See Also Taxonomy Lists](/taxonomies/lists/) -## Ordering Content within Indexes +## Ordering Content within Taxonomies -Hugo uses both **Date** and **Weight** to order content within indexes. +Hugo uses both **Date** and **Weight** to order content within taxonomies. Each piece of content in Hugo can optionally be assigned a date. -It can also be assigned a weight for each index it is assigned to. +It can also be assigned a weight for each taxonomy it is assigned to. -When iterating over content within indexes the default sort is first by weight then by date. This means that if the weights for two pieces of content are the same, than the more recent content will be displayed first. The default weight for any piece of content is 0. +When iterating over content within taxonomies the default sort is first by weight then by date. This means that if the weights for two pieces of content are the same, than the more recent content will be displayed first. The default weight for any piece of content is 0. ### Assigning Weight -Content can be assigned weight for each index that it's assigned to. +Content can be assigned weight for each taxonomy that it's assigned to. +++ tags = [ "a", "b", "c" ] @@ -63,12 +65,12 @@ Content can be assigned weight for each index that it's assigned to. Front Matter with weighted tags and categories -The convention is `indexname_weight`. +The convention is `taxonomyname_weight`. -In the above example, this piece of content has a weight of 22 which applies to the sorting when rendering the pages assigned to the "a", "b" and "c" values of the 'tag' index. +In the above example, this piece of content has a weight of 22 which applies to the sorting when rendering the pages assigned to the "a", "b" and "c" values of the 'tag' taxonomy. It has also been assigned the weight of 44 when rendering the 'd' category. -With this the same piece of content can appear in different positions in different indexes. +With this the same piece of content can appear in different positions in different taxonomies. -Currently indexes only support the default ordering of content which is weight -> date. +Currently taxonomies only support the default ordering of content which is weight -> date. diff --git a/docs/content/taxonomies/overview.md b/docs/content/taxonomies/overview.md index e25917ec..b9244ef5 100644 --- a/docs/content/taxonomies/overview.md +++ b/docs/content/taxonomies/overview.md @@ -1,76 +1,89 @@ --- title: "Taxonomy Overview" +linktitle: "Overview" date: "2013-07-01" aliases: ["/indexes/overview/","/doc/indexes/", "/extras/indexes"] weight: 10 menu: main: parent: 'taxonomy' + identifier: 'taxonomy overview' +prev: "/templates/404" +next: "/taxonomies/usage" --- -Hugo includes support for user defined groupings of content called indexes. - -Indexes can be used to organize content in a variety of ways. For example, if I -wanted to use a wordpress style organization I would create two indexes called -"categories" and "tags". Other common uses would include categories, tags, groups, -navigation, series and many more. Just think of an index as way to organize similar content. - -It's important to understand what Indexes do. At it's most basic form an index -is simply a map of a key to a list of content values. - -In the hugo internals this is stored as `Site.Indexes[Plural][key][]pages`. -For example all the content tagged with Go would be found at -`Site.Indexes["tags"]["Go"]`. - -For a -more complete example see the source of [this docs site](http://github.com/spf13/hugo/docs/). - -## Defining Indexes for a site - -Indexes must be defined in the site configuration, before they -can be used throughout the site. - -Here is an example configuration in YAML that specifies two indexes. -Notice the format is **singular key** : *plural value*. While -we could use an inflection library to pluralize this, they currently -support only a few languages, so instead we've opted for user defined -pluralization. - -### config.yaml - - --- - indexes: - tag: "tags" - category: "categories" - baseurl: "http://spf13.com/" - title: "Steve Francia is spf13.com" - --- - -## Assigning index values to content - -Once an index is defined at the site level, any piece of content -can be assigned to it regardless of content type or section. - -Assigning content to an index is done in the front matter. -Simply create a variable with the *plural* name of the index -and assign all keys you want this content to match against. - -**Index values are case insensitive** - -### Example - - { - "title": "Hugo: A fast and flexible static site generator", - "tags": [ - "Development", - "Go", - "fast", - "Blogging" - ], - "categories" : [ - "Development" - ] - "slug": "hugo", - "project_url": "http://github.com/spf13/hugo" - } +Hugo includes support for user defined groupings of content called +taxonomies. Taxonomies give us a way to classify our content so we can +demonstrate relationships in a variety of logical ways. + +The default taxonomies for Hugo are tags and categories. These +taxonomies are common to many websites systems (Wordpress, Drupal, +Jekyll). Unlike all of those Systems, Hugo makes it trivial to customize +the taxonomies you will be using for your site however you wish. Another +good use for taxonomies is to group a set of posts into a series. Other +common uses would include categories, tags, groups, series and many +more. + +When taxonomies are used (and templates are provided) Hugo will +automatically create pages listing all of the taxonomies, their terms +and all of the content attached to those terms. + +## Definitions + +**Taxonomy:** A categorization that can be used to classify content + +**Term:** A key within that taxonomy + +**Value:** A piece of content assigned to that Term + +## Example + +For example if I was writing about movies I may want the following +taxonomies: + +* Actors +* Directors +* Studios +* Genre +* Year +* Awards + +I would then specify in each movies front-matter the specific terms for +each of those taxonomies. Hugo would then automatically create pages for +each Actor, Director, Studio, Genre, Year and Award listing all of the +Movies that matched that specific Actor, Director, etc. + + +### Taxonomy Organization + +Letâs use an example to demonstrate the different labels in action. +From the perspective of the taxonomy it could be visualized as: + + Actor <- Taxonomy + Bruce Willis <- Term + The Six Sense <- Content + Unbreakable <- Content + Moonrise Kingdom <- Content + Samuel L. Jackson <- Term + Unbreakable <- Content + The Avengers <- Content + xXx <- Content + +From the perspective of the content if would appear differently, though +the data and labels used are the same: + + Unbreakable <- Content + Actors <- Taxonomy + Bruce Willis <- Term + Samuel L. Jackson <- Term + Director <- Taxonomy + M. Night Shyamalan <- Term + ... + Moonrise Kingdom <- Content + Actors <- Taxonomy + Bruce Willis <- Term + Bill Murray <- Term + Director <- Taxonomy + Wes Anderson <- Term + ... diff --git a/docs/content/taxonomies/templates.md b/docs/content/taxonomies/templates.md index 716b1048..969d27a1 100644 --- a/docs/content/taxonomies/templates.md +++ b/docs/content/taxonomies/templates.md @@ -7,50 +7,18 @@ weight: 30 menu: main: parent: 'taxonomy' +prev: "/templates/displaying" +next: "/taxonomies/ordering" --- -There are two different templates that the use of indexes will require you to provide. +There are two different templates that the use of taxonomies will require you to provide. -The first is a list of all the content assigned to a specific index key. The -second is a [list](/indexes/lists/) of all keys for that index. This document -addresses the template used for the first type. +Both templates are covered in detail in the templates section. -## Creating index templates -For each index type a template needs to be provided to render the index page. -In the case of tags, this will render the content for `/tags/TAGNAME/`. +A [list template](/templates/list/) is any template that will be used to render multiple pieces of +content in a single html page. This template will be used to generate +all the automatically created taxonomy pages. -The template must be called the singular name of the index and placed in -layouts/indexes +A [taxonomy terms template](/templates/terms/) is a template used to +generate the list of terms for a given template. - . - âââ layouts - âââ indexes - âââ category.html - -The template will be provided Data about the index. - -## Variables - -The following variables are available to the index template: - -**.Title** The title for the content.
-**.Date** The date the content is published on.
-**.Permalink** The Permanent link for this page.
-**.RSSLink** Link to the indexes' rss link.
-**.Data.Pages** The content that is assigned this index.
-**.Data.`singular`** The index itself.
- -## Example - {{ template "chrome/header.html" . }} - {{ template "chrome/subheader.html" . }} - -

- {{ range .Data.Pages }} - {{ .Render "summary"}} - {{ end }} -

- - {{ template "chrome/footer.html" }} diff --git a/docs/content/taxonomies/usage.md b/docs/content/taxonomies/usage.md new file mode 100644 index 00000000..49ac2b06 --- /dev/null +++ b/docs/content/taxonomies/usage.md @@ -0,0 +1,60 @@ +--- +title: "Using Taxonomies" +linktitle: "Usage" +date: "2014-05-26" +weight: 15 +menu: + main: + parent: 'taxonomy' +prev: "/taxonomies/overview" +next: "/taxonomies/displaying" +--- + +## Defining taxonomies for a site + +Taxonomies must be defined in the site configuration, before they can be +used throughout the site. You need to provide both the plural and +singular labels for each taxonomy. + +Here is an example configuration in YAML that specifies two taxonomies. + +Notice the format is **singular key** : *plural value*. +### config.yaml + + --- + taxonomies: + tag: "tags" + category: "categories" + series: "series" + --- + +## Assigning taxonomy values to content + +Once an taxonomy is defined at the site level, any piece of content +can be assigned to it regardless of content type or section. + +Assigning content to an taxonomy is done in the front matter. +Simply create a variable with the *plural* name of the taxonomy +and assign all terms you want to apply to this content. + +**taxonomy values are case insensitive** + +### Front Matter Example (in JSON) + + { + "title": "Hugo: A fast and flexible static site generator", + "tags": [ + "Development", + "Go", + "fast", + "Blogging" + ], + "categories" : [ + "Development" + ], + "series" : [ + "Go Web Dev" + ], + "slug": "hugo", + "project_url": "http://github.com/spf13/hugo" + } diff --git a/docs/content/templates/404.md b/docs/content/templates/404.md new file mode 100644 index 00000000..fd3ff04a --- /dev/null +++ b/docs/content/templates/404.md @@ -0,0 +1,40 @@ +--- +title: "404.html Templates" +linktitle: "404" +date: "2013-08-21" +notoc: true +weight: 100 +menu: + main: + parent: 'layout' +aliases: ["/layout/404/"] +prev: "/templates/sitemap" +next: "/taxonomies/overview" +--- + +When using Hugo with [github pages](http://pages.github.com/) you can provide +your own 404 template by creating a 404.html file in the root. + +404 pages are of the type "node" and have all the [node +variables](/layout/variables/) available to use in the templates. + +In addition to the standard node variables, the homepage has access to +all site content accessible from .Data.Pages + + â¾ layouts/ + 404.html + +## 404.html +This is a basic example of a 404.html template: + + {{ template "chrome/header.html" . }} + {{ template "chrome/subheader.html" . }} + +

+ + {{ template "chrome/footer.html" }} + diff --git a/docs/content/templates/content.md b/docs/content/templates/content.md new file mode 100644 index 00000000..e4ac4c43 --- /dev/null +++ b/docs/content/templates/content.md @@ -0,0 +1,160 @@ +--- +title: "Single Content Template" +linktitle: "Single" +date: "2013-07-01" +weight: 30 +menu: + main: + parent: 'layout' +aliases: ["/layout/functions/"] +prev: "/templates/variables" +next: "/templates/list" +--- + +The primary view of content in hugo is the single view. Hugo for every +markdown file provided hugo will render it with a single template. + + +## Which Template will be rendered? +Hugo uses a set of rules to figure out which template to use when +rendering a specific page. + +Hugo will use the following prioritized list. If a file isnât present +than the next one in the list will be used. This enables you to craft +specific layouts when you want to without creating more templates +then necessary. For most sites only the \_default file at the end of +the list will be needed. + +Users can specify the `type` and `layout` in the [front-matter](/content/front-matter). `Section` +is determined based on the content fileâs location. If `type` is provide +it will be used instead of `section`. + +### Single + +* /layouts/`TYPE` or `SECTION`/`LAYOUT`.html +* /layouts/`TYPE` or `SECTION`/single.html +* /layouts/\_default/single.html +* /themes/`THEME`/layouts/`TYPE` or `SECTION`/`LAYOUT`.html +* /themes/`THEME`/layouts/`TYPE` or `SECTION`/single.html +* /themes/`THEME`/layouts/\_default/single.html + +## Example Single Template File + +Content pages are of the type "page" and have all the [page +variables](/layout/variables/) and [site +variables](/templates/variables/) available to use in the templates. + +In the following examples we have created two different content types as well as +a default content type. + +The default content template to be used in the event that a specific +template has not been provided for that type. The default type works the +same as the other types but the directory must be called "\_default". + + â¾ layouts/ + â¾ _default/ + single.html + â¾ post/ + single.html + â¾ project/ + single.html + + +## post/single.html +This content template is used for [spf13.com](http://spf13.com). +It makes use of [partial templates](/layout/partials) + + {{ template "partials/header.html" . }} + {{ template "partials/subheader.html" . }} + {{ $baseurl := .Site.BaseUrl }} + +

+ {{ .Content }} +

+ + + + {{ template "partials/disqus.html" . }} + {{ template "partials/footer.html" . }} + + +## project/single.html +This content template is used for [spf13.com](http://spf13.com). +It makes use of [partial templates](/layout/partials) + + + {{ template "partials/header.html" . }} + {{ template "partials/subheader.html" . }} + {{ $baseurl := .Site.BaseUrl }} + +

+ {{ .Content }} +

+ + + + {{if isset .Params "project_url" }} +

+ Fork me on GitHub +

+ {{ end }} + + {{ template "partials/footer.html" }} + +Notice how the project/single.html template uses an additional parameter unique +to this template. This doesn't need to be defined ahead of time. If the key is +present in the front matter than it can be used in the template. To +easily generate new content of this type with these keys ready use +[content archetypes](/content/archetypes). diff --git a/docs/content/templates/functions.md b/docs/content/templates/functions.md new file mode 100644 index 00000000..307a0cff --- /dev/null +++ b/docs/content/templates/functions.md @@ -0,0 +1,108 @@ +--- +title: "Hugo Template Functions" +date: "2013-07-01" +linktitle: "Functions" +aliases: ["/layout/functions/"] +weight: 20 +menu: + main: + parent: 'layout' +prev: "/templates/go-templates" +next: "/templates/variables" +--- + +Hugo uses the excellent go html/template library for its template engine. +It is an extremely lightweight engine that provides a very small amount of +logic. In our experience that it is just the right amount of logic to be able +to create a good static website. + +Go templates are lightweight but extensible. Hugo has added the following +functions to the basic template logic. + +Go documentation for the built-in functions can be found [here](http://golang.org/pkg/text/template/) + +## General + +### isset +Return true if the parameter is set. +Takes either a slice, array or channel and an index or a map and a key as input. + +eg. {{ if isset .Params "project_url" }} {{ index .Params "project_url" }}{{ end }} + +### echoParam +If parameter is set, then echo it. + +eg. {{echoParam .Params "project_url" }} + +### first +Slices an array to only the first X elements. + +eg. + {{ range first 10 .Data.Pages }} + {{ .Render "summary"}} + {{ end }} + + +## Math + +### add +Adds two integers. + +eg {{add 1 2}} -> 3 + +### sub +Subtracts two integers. + +eg {{sub 3 2}} -> 1 + +### div +Divides two integers. + +eg {{div 6 3}} -> 2 + +### mul +Multiplies two integers. + +eg {{mul 2 3}} -> 6 + +### mod +Modulus of two integers. + +eg {{mod 15 3}} -> 0 + +### modBool +Boolean of modulus of two integers. +true if modulus is 0. + +eg {{modBool 15 3}} -> true + +## Strings + +### urlize +Takes a string and sanitizes it for usage in urls, converts spaces to "-". + +eg. <a href="/tags/{{ . | urlize }}">{{ . }}</a> + +### safeHtml +Declares the provided string as "safe" so go templates will not filter it. + +eg. {{ .Params.CopyrightHTML | safeHtml }} + +### lower +Convert all characters in string to lowercase. + +eg {{lower "BatMan"}} -> "batman" + +### upper +Convert all characters in string to uppercase. + +eg {{upper "BatMan"}} -> "BATMAN" + +### title +Convert all characters in string to titlecase. + +eg {{title "BatMan"}} -> "Batman" + +### highlight +Take a string of code and a language, uses pygments to return the syntax +highlighted code in html. Used in the [highlight shortcode](/extras/highlight). diff --git a/docs/content/templates/go-templates.md b/docs/content/templates/go-templates.md new file mode 100644 index 00000000..32031a2c --- /dev/null +++ b/docs/content/templates/go-templates.md @@ -0,0 +1,338 @@ +--- +title: "Go Template Primer" +date: "2013-07-01" +aliases: ["/layout/go-templates/"] +weight: 15 +menu: + main: + parent: 'layout' +prev: "/templates/overview" +next: "/templates/functions" +--- + +Hugo uses the excellent [go][] [html/template][gohtmltemplate] library for +its template engine. It is an extremely lightweight engine that provides a very +small amount of logic. In our experience that it is just the right amount of +logic to be able to create a good static website. If you have used other +template systems from different languages or frameworks you will find a lot of +similarities in go templates. + +This document is a brief primer on using go templates. The [go docs][gohtmltemplate] +provide more details. + +## Introduction to Go Templates + +Go templates provide an extremely simple template language. It adheres to the +belief that only the most basic of logic belongs in the template or view layer. +One consequence of this simplicity is that go templates parse very quickly. + +A unique characteristic of go templates is they are content aware. Variables and +content will be sanitized depending on the context of where they are used. More +details can be found in the [go docs][gohtmltemplate]. + +## Basic Syntax + +Go lang templates are html files with the addition of variables and +functions. + +**Go variables and functions are accessible within {{ }}** + +Accessing a predefined variable "foo": + + {{ foo }} + +**Parameters are separated using spaces** + +Calling the add function with input of 1, 2: + + {{ add 1 2 }} + +**Methods and fields are accessed via dot notation** + +Accessing the Page Parameter "bar" + + {{ .Params.bar }} + +**Parentheses can be used to group items together** + + {{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }} + + +## Variables + +Each go template has a struct (object) made available to it. In hugo each +template is passed either a page or a node struct depending on which type of +page you are rendering. More details are available on the +[variables](/layout/variables) page. + +A variable is accessed by referencing the variable name. + + {{ .Title }} + +Variables can also be defined and referenced. + + {{ $address := "123 Main St."}} + {{ $address }} + + +## Functions + +Go template ship with a few functions which provide basic functionality. The go +template system also provides a mechanism for applications to extend the +available functions with their own. [Hugo template +functions](/layout/functions) provide some additional functionality we believe +are useful for building websites. Functions are called by using their name +followed by the required parameters separated by spaces. Template +functions cannot be added without recompiling hugo. + +**Example:** + + {{ add 1 2 }} + +## Includes + +When including another template you will pass to it the data it will be +able to access. To pass along the current context please remember to +include a trailing dot. The templates location will always be starting at +the /layout/ directory within Hugo. + +**Example:** + + {{ template "chrome/header.html" . }} + + +## Logic + +Go templates provide the most basic iteration and conditional logic. + +### Iteration + +Just like in go, the go templates make heavy use of range to iterate over +a map, array or slice. The following are different examples of how to use +range. + +**Example 1: Using Context** + + {{ range array }} + {{ . }} + {{ end }} + +**Example 2: Declaring value variable name** + + {{range $element := array}} + {{ $element }} + {{ end }} + +**Example 2: Declaring key and value variable name** + + {{range $index, $element := array}} + {{ $index }} + {{ $element }} + {{ end }} + +### Conditionals + +If, else, with, or, & and provide the framework for handling conditional +logic in Go Templates. Like range, each statement is closed with `end`. + + +Go Templates treat the following values as false: + +* false +* 0 +* any array, slice, map, or string of length zero + +**Example 1: If** + + {{ if isset .Params "title" }}

{{ end }} + +**Example 2: If -> Else** + + {{ if isset .Params "alt" }} + {{ index .Params "alt" }} + {{else}} + {{ index .Params "caption" }} + {{ end }} + +**Example 3: And & Or** + + {{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} + +**Example 4: With** + +An alternative way of writing "if" and then referencing the same value +is to use "with" instead. With rebinds the context `.` within its scope, +and skips the block if the variable is absent. + +The first example above could be simplified as: + + {{ with .Params.title }}

{{ end }} + +**Example 5: If -> Else If** + + {{ if isset .Params "alt" }} + {{ index .Params "alt" }} + {{ else if isset .Params "caption" }} + {{ index .Params "caption" }} + {{ end }} + +## Pipes + +One of the most powerful components of go templates is the ability to +stack actions one after another. This is done by using pipes. Borrowed +from unix pipes, the concept is simple, each pipeline's output becomes the +input of the following pipe. + +Because of the very simple syntax of go templates, the pipe is essential +to being able to chain together function calls. One limitation of the +pipes is that they only can work with a single value and that value +becomes the last parameter of the next pipeline. + +A few simple examples should help convey how to use the pipe. + +**Example 1 :** + + {{ if eq 1 1 }} Same {{ end }} + +is the same as + + {{ eq 1 1 | if }} Same {{ end }} + +It does look odd to place the if at the end, but it does provide a good +illustration of how to use the pipes. + +**Example 2 :** + + {{ index .Params "disqus_url" | html }} + +Access the page parameter called "disqus_url" and escape the HTML. + +**Example 3 :** + + {{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} + Stuff Here + {{ end }} + +Could be rewritten as + + {{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }} + Stuff Here + {{ end }} + + +## Context (aka. the dot) + +The most easily overlooked concept to understand about go templates is that {{ . }} +always refers to the current context. In the top level of your template this +will be the data set made available to it. Inside of a iteration it will have +the value of the current item. When inside of a loop the context has changed. . +will no longer refer to the data available to the entire page. If you need to +access this from within the loop you will likely want to set it to a variable +instead of depending on the context. + +**Example:** + + {{ $title := .Site.Title }} + {{ range .Params.tags }} +

{{ . }} - {{ $title }}

+ {{ end }} + +Notice how once we have entered the loop the value of {{ . }} has changed. We +have defined a variable outside of the loop so we have access to it from within +the loop. + +# Hugo Parameters + +Hugo provides the option of passing values to the template language +through the site configuration (for sitewide values), or through the meta +data of each specific piece of content. You can define any values of any +type (supported by your front matter/config format) and use them however +you want to inside of your templates. + + +## Using Content (page) Parameters + +In each piece of content you can provide variables to be used by the +templates. This happens in the [front matter](/content/front-matter). + +An example of this is used in this documentation site. Most of the pages +benefit from having the table of contents provided. Sometimes the TOC just +doesn't make a lot of sense. We've defined a variable in our front matter +of some pages to turn off the TOC from being displayed. + +Here is the example front matter: + +``` +--- +title: "Permalinks" +date: "2013-11-18" +aliases: + - "/doc/permalinks/" +groups: ["extras"] +groups_weight: 30 +notoc: true +--- +``` + +Here is the corresponding code inside of the template: + + {{ if not .Params.notoc }} +

+ {{ .TableOfContents }} +

+ {{ end }} + + + +## Using Site (config) Parameters +In your top-level configuration file (eg, `config.yaml`) you can define site +parameters, which are values which will be available to you in chrome. + +For instance, you might declare: + +```yaml +params: + CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved." + TwitterUser: "spf13" + SidebarRecentLimit: 5 +``` + +Within a footer layout, you might then declare a `

{{ .Title }}

{{ .Title }}

{{ .Title }}

{{ .Title }}

{{ index .Params "title" }}

{{ . }}