10.2 Markup rules for publishing

muse-publish-markup-regexps

List of markup rules for publishing a page with Muse.

The rules given in this variable are invoked first, followed by whatever rules are specified by the current style.

Each member of the list is either a function, or a list of the following form.

     (REGEXP/SYMBOL TEXT-BEGIN-GROUP REPLACEMENT-TEXT/FUNCTION/SYMBOL)

• REGEXP A regular expression, or symbol whose value is a regular expression, which is searched for using `re-search-forward'.
• TEXT-BEGIN-GROUP The matching group within that regexp which denotes the beginning of the actual text to be marked up.
• REPLACEMENT-TEXT A string that will be passed to `replace-match'.

  If it is not a string, but a function, it will be called to determine what the replacement text should be (it must return a string). If it is a symbol, the value of that symbol should be a string.

The replacements are done in order, one rule at a time. Writing the regular expressions can be a tricky business. Note that case is never ignored. `case-fold-search' is always bound to nil while processing the markup rules.

Publishing order

This is the order that the publishing rules are consulted, by default. This may be changed by customizing muse-publish-markup-regexps.

trailing and leading whitespace

Remove trailing and leading whitespace from a file.

directive

‘#directive’

This is only recognized at the beginning of a file.

comment

‘; a commented line’

tag

‘<tag>’

comment

‘; comment’

explicit links

Prevent emphasis characters in explicit links from being marked up.

Don't actually publish them here, just add a special no-emphasis text property.

word

Whitespace-delimited word, possibly with emphasis characters

This function is responsible for marking up emphasis and escaping some specials.

heading

‘** Heading’

Outline-mode style headings.

enddots

‘....’

These are ellipses with a dot at end.

dots

‘...’

Ellipses.

rule

‘----’

Horizontal rule or section separator.

no-break-space

‘~~’

Prevent lines from being split before or after these characters.

line-break

‘<br>’

Break a line at point.

fn-sep

‘Footnotes:’

Beginning of footnotes section.

footnote

‘[1]’

Footnote definition or reference. If at beginning of line, it is a definition.

list

• ‘ 1. ’
• ‘ - ’
• ‘term :: ’

Numbered list, item list, or term definition list.

table-el

table.el style tables

table

‘table | cells’

Muse tables or orgtbl-mode style tables.

quote

spaces before beginning of text

Blockquotes.

emdash

‘--’

2-wide dash

verse

‘> verse text’

anchor

‘#anchor’

link

‘[[explicit][links]]’

url

‘http://example.com/’

email

‘[email protected]’