ref: a220a3ba37dbda2ea2582a1446dc8d5e752188df
parent: bcdad02c06a2ceb2d9359506279ada05509d68f7
author: Anthony Fok <[email protected]>
date: Tue Mar 17 19:53:17 EDT 2015
[Docs] Copyedit http://gohugo.io/extras/dynamiccontent/
--- a/docs/content/extras/dynamiccontent.md
+++ b/docs/content/extras/dynamiccontent.md
@@ -11,7 +11,7 @@
weight: 91
---
-Dynamic content with a static site generator? Yes it is possible!
+Dynamic content with a static site generator? Yes, it is possible!
In addition to the [data files](/extras/datafiles/) feature, we have also
implemented the feature "Dynamic Content", which lets you load
@@ -26,23 +26,21 @@
### Calling the functions with an URL
-In any HTML template or Markdown document call the functions like:
+In any HTML template or Markdown document, call the functions like this:
-
{{ $dataJ := getJson "url" }}
{{ $dataC := getCsv "separator" "url" }}
-
-or if you use a prefix or postfix for the URL the functions
+or, if you use a prefix or postfix for the URL, the functions
accept [variadic arguments](http://en.wikipedia.org/wiki/Variadic_function):
{{ $dataJ := getJson "url prefix" "arg1" "arg2" "arg n" }}
{{ $dataC := getCsv "separator" "url prefix" "arg1" "arg2" "arg n" }}
-The separator for `getCsv` must be put on the first position and can be
-only one character long.
+The separator for `getCsv` must be put in the first position and can only
+be one character long.
-All passed arguments will be joined to the final URL, example:
+All passed arguments will be joined to the final URL; for example:
{{ $urlPre := "https://api.github.com" }}
{{ $gistJ := getJson $urlPre "/users/GITHUB_USERNAME/gists" }}
@@ -51,23 +49,23 @@
{{ $gistJ := getJson "https://api.github.com/users/GITHUB_USERNAME/gists" }}
-Eventually you can range over the array. This example will output the
-first 5 Github gists for a user:
+Finally, you can range over an array. This example will output the
+first 5 gists for a GitHub user:
<ul>
- {{ $urlPre := "https://api.github.com" }}
- {{ $gistJ := getJson $urlPre "/users/GITHUB_USERNAME/gists" }}
- {{range first 5 $gistJ }}
- {{ if .public }}
- <li><a href="{{ .html_url }}" target="_blank">{{.description}}</a></li>
- {{ end }}
- {{end}}
+ {{ $urlPre := "https://api.github.com" }}
+ {{ $gistJ := getJson $urlPre "/users/GITHUB_USERNAME/gists" }}
+ {{ range first 5 $gistJ }}
+ {{ if .public }}
+ <li><a href="{{ .html_url }}" target="_blank">{{ .description }}</a></li>
+ {{ end }}
+ {{ end }}
</ul>
### Example for CSV files
-For `getCsv` the one character long separator must be placed on the
+For `getCsv`, the one-character long separator must be placed in the
first position followed by the URL.
<table>
@@ -97,46 +95,46 @@
### Caching of URLs
Each downloaded URL will be cached in the default folder `$TMPDIR/hugo_cache/`.
-The variable `$TMPDIR` will be resolved to your system dependent
+The variable `$TMPDIR` will be resolved to your system-dependent
temporary directory.
-With the command line flag `--cacheDir` you can specify any folder on
+With the command-line flag `--cacheDir`, you can specify any folder on
your system as a caching directory.
If you don't like caching at all, you can fully disable to read from the
-cache with the command line flag `--ignoreCache`. However Hugo will always
+cache with the command line flag `--ignoreCache`. However, Hugo will always
write, on each build of the site, to the cache folder (silent backup).
### Authentication when using REST URLs
-Currently you can only use those authentication methods that can
+Currently, you can only use those authentication methods that can
be put into an URL. [OAuth](http://en.wikipedia.org/wiki/OAuth) or
other authentication methods are not implemented.
### Loading local files
-To load local files with the two functions `getJson` and `getCsv` the
-source files must reside within Hugos working directory. The file
+To load local files with the two functions `getJson` and `getCsv`, the
+source files must reside within Hugo's working directory. The file
extension does not matter but the content.
It applies the same output logic as in the topic: *Calling the functions with an URL*.
-## Live reload
+## LiveReload
There is no chance to trigger a [LiveReload](/extras/livereload/) when
-the content of an URL changes. However when a local JSON/CSV file changes
-then a live reload will be triggered of course. Symlinks not supported.
+the content of an URL changes. However, when a local JSON/CSV file changes,
+then a LiveReload will be triggered of course. Symlinks not supported.
-**URLs and Live reload**: If you change any local file and the live reload
-got triggered Hugo will either read the URL content from the cache or, if
+**URLs and LiveReload**: If you change any local file and the LiveReload
+got triggered, Hugo will either read the URL content from the cache or, if
you have disabled the cache, Hugo will re-download the content.
This can create huge traffic and you may also reach API limits quickly.
As downloading of content takes a while, Hugo stops with processing
-your markdown files until the content has been downloaded.
+your Markdown files until the content has been downloaded.
## Examples
- Photo gallery JSON powered: [https://github.com/pcdummy/hugo-lightslider-example](https://github.com/pcdummy/hugo-lightslider-example)
-- Github Starred Repositories [in a posts](https://github.com/SchumacherFM/blog-cs/blob/master/content%2Fposts%2Fgithub-starred.md) with the related [short code](https://github.com/SchumacherFM/blog-cs/blob/master/layouts%2Fshortcodes%2FghStarred.html).
-- more?
+- GitHub Starred Repositories [in a posts](https://github.com/SchumacherFM/blog-cs/blob/master/content%2Fposts%2Fgithub-starred.md) with the related [short code](https://github.com/SchumacherFM/blog-cs/blob/master/layouts%2Fshortcodes%2FghStarred.html).
+- More? Please tell us!