diff options
Diffstat (limited to 'docs/manual/cross-referencing-blog-pages.rst')
| -rw-r--r-- | docs/manual/cross-referencing-blog-pages.rst | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/docs/manual/cross-referencing-blog-pages.rst b/docs/manual/cross-referencing-blog-pages.rst new file mode 100644 index 0000000..bd4b86b --- /dev/null +++ b/docs/manual/cross-referencing-blog-pages.rst @@ -0,0 +1,47 @@ +Cross-referencing Blog Pages +============================ + +.. post:: May 11, 2014 + :tags: tips, Sphinx + :category: Manual + :location: Pittsburgh + :author: Ahmet + +ABlog creates references to all post and archive pages. +Posts can be cross-referenced using the name of the file, or when the file is named :file:`index`, the name of the folder that contains the file. + +This page, :ref:`cross-referencing-blog-pages`, for example is referenced as ``:ref:`cross-referencing-blog-pages``` using :rst:role:`ref` role. + +When posts have long file names, it may be inconvenient 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. + +.. _archives: + +Archive pages +------------- + +Archive pages, on the other hand, can be cross-referenced by combining archive type and archive name as follows: + +============== ========================== =============================== +Archive Example reStructured Text +============== ========================== =============================== +Posts :ref:`blog-posts` ``:ref:`blog-posts``` +Drafts :ref:`blog-drafts` ``:ref:`blog-drafts``` +Blog Feed :ref:`blog-feed` ``:ref:`blog-feed``` +Author :ref:`author-ahmet` ``:ref:`author-ahmet``` +Language :ref:`language-en` ``:ref:`language-en``` +Location :ref:`location-pittsburgh` ``:ref:`location-pittsburgh``` +============== ========================== =============================== + +Following archive pages list all posts by grouping them: + +============== ========================== =============================== +Archive Example reStructured Text +============== ========================== =============================== +By tag :ref:`blog-tags` ``:ref:`blog-tags``` +By author :ref:`blog-authors` ``:ref:`blog-authors``` +By language :ref:`blog-languages` ``:ref:`blog-languages``` +By location :ref:`blog-locations` ``:ref:`blog-locations``` +By category :ref:`blog-categories` ``:ref:`blog-categories``` +By archive :ref:`blog-archives` ``:ref:`blog-archives``` +============== ========================== =============================== |