Updated posts.

This commit is contained in:
Ahmet Bakan 2014-08-22 20:31:46 -04:00
parent cf2d2e5800
commit d416d9193e
5 changed files with 112 additions and 9 deletions

View file

@ -87,6 +87,33 @@ Post related
Number of seconds (default is ``5``) that a redirect page waits before
refreshing the page to redirect to the post.
Blog feeds
----------
Turn feeds by setting :confval:`blog_baseurl` configuration variable.
.. confval:: blog_feed_archives
Choose to create per author, location, tag, category, and year
feeds, default is ``False``.
.. confval:: blog_feed_fulltext
Choose to display full text in blog feeds, default is ``False``.
.. confval:: blog_feed_subtitle
Blog feed subtitle, default is ``None``.
.. update:: Aug 24, 2014
Added :confval:`blog_feed_archives`, :confval:`blog_feed_fulltext`, and
:confval:`blog_feed_subtitle` options.
.. _fa:
Font awesome

View file

@ -25,7 +25,7 @@ These labels need to be translated. ABlog needs your help.
$ python setup.py extract_messages -o ablog/locale/sphinx.pot
...
This will create a file :xfile:`ablog/locale/sphinx.pot`, the
This will create a file :file:`ablog/locale/sphinx.pot`, the
central messages catalog used by the different translations.
- init_catalog_ must run after extract_messages_ once for each *new* language::

View file

@ -50,4 +50,4 @@ By archive :ref:`blog-archives` ``:ref:`blog-archives```
When posts have long file or folder names, it may be convenient to use
them repeatedly for cross-referencing. An alternative that Sphinx_ offers
is creating your own short and unique labels for cross-referencing to posts.
See :ref:`xref-syntax` for details.
See :ref:`xref-syntax` for details.

View file

@ -7,8 +7,8 @@ Posting and Listing
:location: Pittsburgh
:author: Ahmet
This post describes :rst:dir:`post` and :rst:dir:`postlist` directives
introduced by ABlog.
This post describes :rst:dir:`post`, :rst:dir:`update`, and :rst:dir:`postlist`
directives.
Posting
-------
@ -34,12 +34,12 @@ following directive:
**Drafts & Posts**
Posts without dates or with future dates are considered as drafts and
are published only in :ref:`blog-drafts` page.
are published only in :ref:`blog-drafts` archive page.
Posts with dates that are older than the day Sphinx project is built are
published in :ref:`blog-posts` page.
Post date format must match the format specified with
Post date format must follow the format specified with
:confval:`post_date_format` configuration option.
**Tags & Categories**
@ -56,9 +56,9 @@ following directive:
are accepted.
Using :confval:`blog_authors` and :confval:`blog_locations`
configuration variables, you can also provide links to authors
and locations, which will be displayed in archive pages generated
for all unique authors and locations.
configuration variables, you can also provide home pages and
full names of authors and locations, which will be displayed
in archive pages generated for all unique authors and locations.
**Redirections**
@ -73,6 +73,51 @@ following directive:
You can change this behavior and also add an image to the excerpt.
To find out how, see :ref:`post-excerpts-and-images`.
**Update Notes**
.. rst:directive:: update
Update in a post can be noted anywhere in the post as follows::
.. update:: 20 Apr, 2014
Added :rst:dir:`update` directive and
:ref:`posting-and-listing-posting-sections` section.
Update date format must follow the format specified with
:confval:`post_date_format` configuration option.
Updates content render like the update at the end of this post.
Posting Sections
----------------
.. post:: Aug 20, 2014
:tags: directive
:category: Manual
:location: SF
:author: Ahmet
:rst:dir:`post` directive can be used multiple times in a single page
to create multiple posts of different sections of the document.
Second time a document is posted, post title and excerpt will be extracted
from the section in which the :rst:dir:`post` directive resides and
will be used in archive pages and post lists.
Some caveats and differences from a document posts are:
* Next and previous links at the bottom will only regard the first post
in the document.
* Information displayed on the sidebar will belong to the first post.
* Section posts can be referred using page name and section title,
e.g. ``:ref:`posting-and-listing-posting-sections```.
Multiple use of :rst:dir:`post` may be suitable for major additions
to a previous post. For minor changes, :rst:dir:`update` directive
may be more suitable.
Listing
-------
@ -104,3 +149,9 @@ A list of posts can be displayed in any page using the following directive:
in :ref:`category-manual` and tagged with :ref:`tag-tips`. Posts
will be in reverse chronological order.
.. update:: Aug 20, 2014
Added :rst:dir:`update` directive and
:ref:`posting-and-listing-posting-sections` section.
Also revised the text here and there.

View file

@ -0,0 +1,25 @@
ABlog v0.2 released
===================
.. post:: Aug 22, 2014
:tags: tips
:author: Ahmet
:category: Release
:location: SF
:excerpt: 10
ABlog v0.2 is released. This version comes with several new features:
* You can post a document multiple times, see
:ref:`posting-and-listing-posting-sections` for details.
* You can make notes of updates in a post using :rst:dir:`update`
directive.
* Blog feeds for authors, locations, categories, tags, and years
can be enabled using :confval:`blog_feed_archives` configuration
variable.
* Blog Feeds can be made full text using :confval:`blog_feed_fulltext`
configuration variable.