aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorRafael G. Martins <rafael@rafaelmartins.eng.br>2016-04-30 02:56:33 +0200
committerRafael G. Martins <rafael@rafaelmartins.eng.br>2016-04-30 02:56:33 +0200
commit95b49cad4665bb958d2e1b8e8c8e25a74cffabce (patch)
tree44a4013e250851e954a55b1e33959761de6c829c
parent114b36f95116f62bfcf9d79e441ab81aed35454b (diff)
downloadblogc-95b49cad4665bb958d2e1b8e8c8e25a74cffabce.tar.gz
blogc-95b49cad4665bb958d2e1b8e8c8e25a74cffabce.tar.bz2
blogc-95b49cad4665bb958d2e1b8e8c8e25a74cffabce.zip
man: added documentation for DESCRIPTION variable
-rw-r--r--man/blogc-source.7.ronn7
1 files changed, 6 insertions, 1 deletions
diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn
index 1a2cc76..b583d6e 100644
--- a/man/blogc-source.7.ronn
+++ b/man/blogc-source.7.ronn
@@ -47,7 +47,12 @@ variable. Its value must be a valid strptime(3) format.
The source parser will also automatically generate a variable called `FILENAME`,
that stores the name of the source file, without its extension. This is useful
-for building permalinks in templates.
+for building permalinks in templates. This variable can't be overriden by an
+explicit definition in source file.
+
+Another variable, `DESCRIPTION`, will be automatically created by the source
+parser. Its content is the first line of the first paragraph of the content.
+This variable can be overriden by an explicit definition in source file.
## SOURCE CONTENT - BLOCK ELEMENTS