Article Starting Point
Sample RST content to start from and modify for your article.
Main Header for your article
#############################################
:lang: en
:category: a valid category
:date: 2025-10-11 20:03:36+00:00
:tags: article, template
:slug: unique-article-name
:authors: Pierre Bernatchez
:summary: One line Summary of your article
.. |copy| unicode:: 0xA9 .. copyright sign
.. |---| unicode:: U+02014 .. em dash
:trim:
.. footer:: Copyright |copy| 2025 Pierre Bernatchez |---| all rights reserved.
Start here
Modify the main header to something suitable for your artricle.
Modify category to one appropriate for your article.
Modify date. You can use command line command "date -u --rfc-3339=seconds" to get a correctly formatted date string.
Modify tags to relevant keywords for your article.
Modify slug to be the unique name for your article. We use that as the basis for the file name of the .rst file. Like this slugname-en.rst, slugname-es.rst, slugname-fr.rst are the 3 language file names for the article with the slug: slugname.
Modify authors to your own name.
Modify summary to something appropriate to your article.
Modify the name in the footer line to yours also.
Write your article, using RST markup beginning at start here
Note that there there are two convenience python scripts that can generate something to start from for a new article.
Generate an article starting point with no image
newarticle -h
usage: newarticle [-h] [-a AUTHOR] [-l {en,fr,es,all}] [-d DUP] [-r]
articlename
Generate a skeleton article file
positional arguments:
articlename article name without the "-en.rst")
options:
-h, --help show this help message and exit
-a AUTHOR, --author AUTHOR
Author for copyright and for authors (default "Pierre
Bernatchez)"
-l {en,fr,es,all}, --lang {en,fr,es,all}
language of the new article (default: all)
-d DUP, --dup DUP Existing article name to duplicate category and tags
(default None)
-r, --recipe Treat this as a recipe. (Othewise generic)
OR
Generate an article starting point with an image
newshot -h
Output
usage: newshot [-h] [-a AUTHOR] [-l {en,fr,es,all}] [-d DUP] [-j] [-r]
articlename
Generate a skeleton article file which has a srcreenshot
positional arguments:
articlename article name without the "-en.rst")
options:
-h, --help show this help message and exit
-a AUTHOR, --author AUTHOR
Author for copyright and for authors (default "Pierre
Bernatchez)"
-l {en,fr,es,all}, --lang {en,fr,es,all}
language of the new article (default: all)
-d DUP, --dup DUP Existing article name to duplicate category and tags
(default None)
-j, --jpg Reference image as a .jpg rather than a .png a
(default: False)
-r, --recipe Treat this as a recipe. (Othewise generic)