diff options
| author | Rafael G. Martins <rafael@rafaelmartins.eng.br> | 2015-06-14 02:37:32 -0300 |
|---|---|---|
| committer | Rafael G. Martins <rafael@rafaelmartins.eng.br> | 2015-06-14 02:37:32 -0300 |
| commit | 9476381cd2a130aebecbfbbbae29e0c6f9bbaafc (patch) | |
| tree | 832cad8074a4db8e1646711ffc2d8f2a0628f7d7 | |
| parent | 9ec90abdabefba18b8bd65392f539f5da7e4f37b (diff) | |
| download | blogc-9476381cd2a130aebecbfbbbae29e0c6f9bbaafc.tar.gz blogc-9476381cd2a130aebecbfbbbae29e0c6f9bbaafc.tar.bz2 blogc-9476381cd2a130aebecbfbbbae29e0c6f9bbaafc.zip | |
improved man pages
| -rw-r--r-- | man/blogc-source.7.ronn | 33 | ||||
| -rw-r--r-- | man/blogc.1.ronn | 4 |
2 files changed, 31 insertions, 6 deletions
diff --git a/man/blogc-source.7.ronn b/man/blogc-source.7.ronn index 71be994..3c3c011 100644 --- a/man/blogc-source.7.ronn +++ b/man/blogc-source.7.ronn @@ -1,11 +1,36 @@ blogc-source(7) -- blogc's source file format ============================================= -## SYNOPSIS +## DESCRIPTION -TODO +Source files are used as input data to the blogc(1) compiler. They provide +variables and content, that are used by the compiler to fill the gaps available +in the templates (see blogc-template(7)). -## DESCRIPTION +The syntax of the source files is designed to be as simple as possible. The +variables are defined in the top of the file as key-value lines, and the +content is defined right after the variables. + +Content is written in a markup language that is similar to John Gruber's +Markdown, but that is NOT Markdown. This language is very simple, while +powerful enough to write big posts. + +## SOURCE VARIABLES + +Variables are key-value lines. The variable name must be upper-case, starting +with a letter and following with one or more letters and/or underscores. The +value is separated from the variable name with a ':' and finishes in the end +of the line. Multi-line values are not supported. + + VARIABLE1: Value of variable one + VARIABLE2: Value of variable two + -------------------------------- + +All the variables defined in the source files are local and will override +global variables provided to blogc(1) in the command-line, but just inside +blocks that handle local variables. See blogc-template(7) for details. + +## SOURCE CONTENT TODO @@ -15,4 +40,4 @@ Rafael G. Martins <<rafael@rafaelmartins.eng.br>> ## SEE ALSO -blogc(1), strptime(3) +blogc(1), blogc-template(7), strptime(3) diff --git a/man/blogc.1.ronn b/man/blogc.1.ronn index d657529..7071f6d 100644 --- a/man/blogc.1.ronn +++ b/man/blogc.1.ronn @@ -44,7 +44,7 @@ designed to be used with make(1). * `-p` <KEY>: Show the value of a global configuration parameter right after the source parsing and exits. This is useful to get parameters for your `Makefile`, - like the last page when using pagination support. + like the last page when using pagination. * `-t` <TEMPLATE>: Template file. It is a required option, if `blogc` needs to render something. @@ -68,7 +68,7 @@ source files blogc-source(7) and an output file, if wanted. ## ENVIRONMENT No environment variables are required by `blogc`, but global timezone will -be used by locale-dependant datetime input field descriptors (like `%c`, and +be used by locale-dependant datetime input field descriptors (like `%c`), and can be overridden using environment variables. See strptime(3). ## EXAMPLES |