9.7 Keeping a journal or blog

The module facilitates the keeping and publication of a journal. When publishing to HTML, it assumes the form of a web log, or blog.

The input format for each entry is as follows.

     * 20040317: Title of entry
     
     text for the entry.
     
     <qotd>
     "You know who you are. It comes down to a simple gut check: You
     either love what you do or you don't. Period." -- P. Bronson
     </qotd>

The "qotd", or Quote of the Day, is entirely optional. When generated to HTML, this entry is rendered as the following.

     <div class="entry">
       <div class="entry-qotd">
         <h3>Quote of the Day:</h3>
         <p>"You know who you are. It comes down to a simple gut
           check: You either love what you do or you don't. Period."
           -- P. Bronson</p>
       </div>
       <div class="entry-body">
         <div class="entry-head">
           <div class="entry-date">
             <span class="date">March 17, 2004</span>
           </div>
           <div class="entry-title">
             <h2>Title of entry</h2>
           </div>
         </div>
         <div class="entry-text">
           <p>Text for the entry.</p>
         </div>
       </div>
     </div>

The plurality of "div" tags makes it possible to display the entries in any form you wish, using a CSS style.

Also, an .RDF file can be generated from your journal by publishing it with the "rdf" style. It uses the first two sentences of the first paragraph of each entry as its "description", and auto-generates tags for linking to the various entries.

muse-project-alist considerations

If you wish to publish an RDF or RSS feed, it is important to include the :base-url attribute in your muse-project-alist entry for your Journal projects. An example follows.

     (setq muse-project-alist
           '(("Journal" ("~/Journal/"
                         :default "journal")
             (:base "journal-rss"
                    :base-url "http://example.org/journal/"
                    :path "~/public_html/journal"))))

Styles provided

journal-html

Publish journal entries as an HTML document.

journal-xhtml

Publish journal entries as an XHTML document.

journal-latex

Publish journal entries as a LaTeX document.

journal-pdf

Publish journal entries as a PDF document.

journal-book-latex

Publish journal entries as a LaTeX book.

journal-book-pdf

Publish journal entries as a PDF book.

journal-rdf

Publish journal entries as an RDF file (RSS 1.0).

journal-rss

Publish journal entries as an RSS file (RSS 2.0).

journal-rss-entry

Used internally by journal-rss and journal-rdf for publishing individual entries.

Options provided

muse-journal-heading-regexp

A regexp that matches a journal heading.

Paren group 1 is the ISO date, group 2 is the optional category, and group 3 is the optional heading for the entry.

muse-journal-date-format

Date format to use for journal entries.

muse-journal-html-heading-regexp

A regexp that matches a journal heading from an HTML document.

Paren group 1 is the ISO date, group 2 is the optional category, and group 3 is the optional heading for the entry.

muse-journal-html-entry-template

Template used to publish individual journal entries as HTML.

This may be text or a filename.

muse-journal-latex-section

Template used to publish a LaTeX section.

muse-journal-latex-subsection

Template used to publish a LaTeX subsection.

muse-journal-markup-tags

A list of tag specifications, for specially marking up Journal entries.

See muse-publish-markup-tags, for more information.

This is used by journal-latex and its related styles, as well as the journal-rss-entry style, which both journal-rdf and journal-rss use.

muse-journal-rdf-extension

Default file extension for publishing RDF (RSS 1.0) files.

muse-journal-rdf-base-url

The base URL of the website referenced by the RDF file.

muse-journal-rdf-header

Header used for publishing RDF (RSS 1.0) files.

This may be text or a filename.

muse-journal-rdf-footer

Footer used for publishing RDF (RSS 1.0) files.

This may be text or a filename.

muse-journal-rdf-date-format

Date format to use for RDF entries.

muse-journal-rdf-entry-template

Template used to publish individual journal entries as RDF.

This may be text or a filename.

muse-journal-rdf-summarize-entries

If non-nil, include only summaries in the RDF file, not the full data.

The default is nil, because this annoys some subscribers.

muse-journal-rss-heading-regexp

A regexp that matches a journal heading from an HTML document.

Paren group 1 is the ISO date, group 2 is the optional category, and group 3 is the optional heading for the entry.

muse-journal-rss-extension

Default file extension for publishing RSS 2.0 files.

muse-journal-rss-base-url

The base URL of the website referenced by the RSS file.

muse-journal-rss-header

Header used for publishing RSS 2.0 files.

This may be text or a filename.

muse-journal-rss-footer

Footer used for publishing RSS 2.0 files.

This may be text or a filename.

muse-journal-rss-date-format

Date format to use for RSS 2.0 entries.

muse-journal-rss-entry-template

Template used to publish individual journal entries as RSS 2.0.

This may be text or a filename.

muse-journal-rss-enclosure-types-alist

File types that are accepted as RSS enclosures.

This is an alist that maps file extension to content type.

Useful for podcasting.

muse-journal-rss-summarize-entries

If non-nil, include only summaries in the RSS file, not the full data.

The default is nil, because this annoys some subscribers.

muse-journal-rss-markup-regexps

List of markup rules for publishing a Muse journal page to RSS.

For more information on the structure of this list, See muse-publish-markup-regexps.

muse-journal-rss-markup-functions

An alist of style types to custom functions for that kind of text.

For more on the structure of this list, See muse-publish-markup-functions.