Next: , Previous: Markup Regexps, Up: Extending Muse


10.3 Strings specific to a publishing style

Markup strings are strings used for marking up text for a particular style.

These cover the most basic kinds of markup, the handling of which differs little between the various styles.

Available markup strings

image-with-desc
An image and a description.

Argument 1: image without extension. Argument 2: image extension. Argument 3: description.

image
An inlined image.

Argument 1: image without extension. Argument 2: image extension.

image-link
An image with a link around it.

Argument 1: link. Argument 2: image without extension. Argument 3: image extension.

anchor-ref
A reference to an anchor on the current page.

Argument 1: anchor name. Argument 2: description if one exists, or the original link otherwise.

url
A URL without a description.

Argument 1: URL.

link
A link to a Muse page with a description.

Argument 1: link. Argument 2: description if one exists, or the original link otherwise.

link-and-anchor
A link to a Muse page with an anchor, and a description.

Argument 1: link. Argument 2: anchor name. Argument 3: description if one exists, or the original link otherwise. Argument 4: link without an extension.

email-addr
A link to an email address.

Argument 1: email address. Argument 2: email address.

anchor
An anchor.

Argument 1: name of anchor.

emdash
A 2-length dash.

Argument 1: Initial whitespace. Argument 2: Terminating whitespace.

comment-begin
Beginning of a comment.
comment-end
End of a comment.
rule
A horizontal line or space.
no-break-space
A space that separates two words which are not to be separated.
footnote
Beginning of footnote.
footnote-end
End of footnote.
footnotemark
Mark a reference for the current footnote.

Argument 1: number of this footnote.

footnotemark-end
End of a reference for the current footnote.
footnotetext
Indicate the text of the current footnote.

Argument 1: number of this footnote.

footnotetext-end
End of a footnote text line.
fn-sep
Text used to replace “Footnotes:” line.
dots
3 dots.
enddots
4 dots.
part
Beginning of a part indicator line. This is used by book publishing.
part-end
End of a part indicator line. This is used by book publishing.
chapter
Beginning of a chapter indicator line. This is used by book publishing.
chapter-end
End of a chapter indicator line. This is used by book publishing.
section
Beginning of level 1 section indicator line.

Argument 1: level of section; always 1.

section-end
End of level 1 section indicator line.

Argument 1: level of section; always 1.

subsection
Beginning of level 2 section indicator line.

Argument 1: level of section; always 2.

subsection-end
End of level 2 section indicator line.

Argument 1: level of section; always 2.

subsubsection
Beginning of level 3 section indicator line.

Argument 1: level of section; always 3.

subsubsection-end
End of level 3 section indicator line.

Argument 1: level of section; always 3.

section-other
Beginning of section indicator line, where level is greater than 3.

Argument 1: level of section.

section-other-end
End of section indicator line, where level is greater than 3.

Argument 1: level of section.

begin-underline
Beginning of underlined text.
end-underline
End of underlined text.
begin-literal
Beginning of verbatim text. This includes <code> tags and =teletype text=.
end-literal
End of verbatim text. This includes <code> tags and =teletype text=.
begin-emph
Beginning of the first level of emphasized text.
end-emph
End of the first level of emphasized text.
begin-more-emph
Beginning of the second level of emphasized text.
end-more-emph
End of the second level of emphasized text.
begin-most-emph
Beginning of the third (and final) level of emphasized text.
end-most-emph
End of the third (and final) level of emphasized text.
begin-verse
Beginning of verse text.
verse-space
String used to each space that is further indented than the beginning of the verse.
begin-verse-line
Beginning of a line of verse.
empty-verse-line
End of a line of verse.
begin-last-stanza-line
Beginning of the last line of a verse stanza.
end-last-stanza-line
End of the last line of a verse stanza.
end-verse
End of verse text.
begin-example
Beginning of an example region. To make use of this, an ‘<example>’ tag is needed.
end-example
End of an example region. To make use of this, an ‘</example>’ tag is needed.
begin-center
Begin a centered line.
end-center
End a centered line.
begin-quote
Begin a quoted region.
end-quote
End a quoted region.
begin-quote-item
Begin a quote paragraph.
end-quote-item
End a quote paragraph.
begin-uli
Begin an unordered list.
end-uli
End an unordered list.
begin-uli-item
Begin an unordered list item.
end-uli-item
End an unordered list item.
begin-oli
Begin an ordered list.
end-oli
End an ordered list.
begin-oli-item
Begin an ordered list item.
end-oli-item
End an ordered list item.
begin-dl
Begin a definition list.
end-dl
End a definition list.
begin-dl-item
Begin a definition list item.
end-dl-item
End a definition list item.
begin-ddt
Begin a definition list term.
end-ddt
End a definition list term.
begin-dde
Begin a definition list entry.
end-dde
End a definition list entry.
begin-table
Begin a table.
end-table
End a table.
begin-table-group
Begin a table grouping.
end-table-group
End a table grouping.
begin-table-row
Begin a table row.
end-table-row
End a table row.
begin-table-entry
Begin a table entry.
end-table-entry
End a table entry.