Document PreserveTaxonomyNames

Fixes #1648
This commit is contained in:
Cameron Moore 2015-12-09 10:25:50 -06:00 committed by Anthony Fok
parent 4a2623c899
commit 280b2f294e
2 changed files with 16 additions and 2 deletions

View file

@ -115,7 +115,9 @@ Following is a list of Hugo-defined variables that you can configure and their c
paginatePath: "page"
permalinks:
# Pluralize titles in lists using inflect
pluralizeListTitles: true
pluralizeListTitles: true
# Preserve special characters in taxonomy names ("Gérard Depardieu" vs "Gerard Depardieu")
preserveTaxonomyNames: false
publishdir: "public"
# color-codes for highlighting derived from this style
pygmentsStyle: "monokai"

View file

@ -53,7 +53,19 @@ 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**
## Preserving taxonomy values
By default, taxonomy names are hyphenated, lower-cased and normalized, and then
fixed and titleized on the archive page.
However, if you want to have a taxonomy value with special characters
such as `Gérard Depardieu` instead of `Gerard Depardieu`,
you need to set the `preserveTaxonomyNames` [site configuration](/overview/configuration/) variable to `true`.
Hugo will then preserve special characters in taxonomy values
but will still titleize the values for titles and normalize them in URLs.
Note that if you use `preserveTaxonomyNames` and intend to manually construct URLs to the archive pages,
you will need to pass the taxonomy values through the `urlize` template function.
### Front Matter Example (in TOML)