Document post format.

* README.org (Post format): New section.

1 files changed, 53 insertions, 0 deletions

diff --git a/README.org b/README.org
index 7e7c405..466405d 100644
--- a/README.org
+++ b/README.org
@@ -69,3 +69,56 @@ Set up /ennum-blog/ with settings relevant for your blog, and run /M-x ennum-pub
           :blog-domain "example.org"
           :blog-license "All content is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License."))
 #+END_SRC
+
+* Post format
+
+Posts are written as Org mode documents. Keywords TITLE, DATE, FILETAGS are used to indicate the title, date, and tags respectively. The SUMMARY keyword is used to specify the short text that should describe the post in post listings such as the index page.
+#+BEGIN_SRC org
+  ,#+TITLE: Gandikota
+  ,#+DATE: <2022-07-02>
+  ,#+FILETAGS: :travel:
+  ,#+SUMMARY: Last week, I visited Gandikota, the ruins of a fort in Andhra Pradesh.
+
+  Furthermore, the theory of syntactic features developed earlier is not to be considered in determining a parasitic gap construction. However, this assumption is not correct, since this analysis of a formative as a pair of sets of features can be defined in such a way as to impose the traditional practice of grammarians. We will bring evidence in favor of the following thesis: a case of semigrammaticalness of a different sort is, apparently, determined by the system of base rules exclusive of the lexicon. Conversely, this selectionally introduced contextual feature is necessary to impose an interpretation on an important distinction in language use. Clearly, most of the methodological work in modern linguistics is to be regarded as nondistinctness in the sense of distinctive feature theory.
+#+END_SRC
+
+** Link types
+
+ennum comes with several built-in link types. The /post/ link type can be used to refer to other of your own posts. The /image/ and /thumbnail/ link types refer to images scaled to different sizes. The /static/, /video/ and /tangle/ link types refer to static files, videos and tangled output respectively. The /tag/ link type refers to a page listing posts of a specific tag. Example usage for these link types is shown below.
+
+#+BEGIN_SRC org
+  Link to post whose basename (that is, filename without the extension) is /foo/
+  [[post:foo]]
+
+  Link to image /bar.jpg/
+  [[image:bar.jpg]]
+
+  Link to thumbnail sized version of image file /bar.jpg/
+  [[thumbnail:bar.jpg]]
+
+  Link to static file
+  [[static:attached-document.odt]]
+
+  Link to video
+  [[video:movie.webm]]
+
+  Link to tangled output file
+  [[tangle:macros.scm]]
+
+  Link to page listing posts tagged /travel/
+  [[tag:travel]]
+#+END_SRC
+
+** Posts in multiple languages
+
+Optionally, you can write your post in a different language and specify the language using the LANGUAGE keyword. If you have the same post translated to different languages, you can group them together using the TRANSLATION_GROUP keyword. All posts with the same TRANSLATION_GROUP will be considered translations of each other, and will link to each other in the exported output. If the TRANSLATION_GROUP keyword is not specified, it defaults to the basename (that is, filename without the extension) of the file. For example, if a post has a filename /foo-bar.org/, then its basename is /foo-bar/.
+#+BEGIN_SRC org
+  ,#+TITLE: Gandikota
+  ,#+DATE: <2022-07-02>
+  ,#+FILETAGS: :travel:
+  ,#+SUMMARY: Lorem ipsum dolor sit amet
+  ,#+LANGUAGE: la
+  ,#+TRANSLATION_GROUP: gandikota
+
+  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+#+END_SRC