Fonts, styles, and symbols
For the most part, the DDC Day theme is responsible for the specific typefaces and styles used in curriculum module web pages. However, the general font characteristics are selected based on the block and span formatting elements included in the content by the curriculum author. Thus, it’s important that the author understand the general typographical characteristics for different content types, to better understand and use the formatting guidelines.
fixed-width
Mathematical expressions.2
Normal text content.1
There are a handful of characters that occur quite frequently in printed English that are not easily typed on the keyboard. Some word processing programs automatically translate to these special characters from common substitutes that are more easily typed; however, most text editors don’t do that. So it is often the case that in e-mail or SMS messages, or even web pages, more easily typed (but incorrect) characters are used in place of the appropriate symbols.
Fortunately, most dialects of Markdown (including that supported by the kramdown parser) include some automatic translations to a few special symbols from substitute character sequences. These are listed below, along with use cases for the symbols. Whenever possible, the correct symbols should be used—whether through these Markdown translations, HTML entities, or other means.
Note that this list does not include mathematical symbols. These should be typed using $\rm\LaTeX$, as described in “Mathematical expressions”.
An ellipsis is used to indicate an omitted section of text, or an omitted portion of a list or sequence. (In conversational-style writing, it’s also used to indicate a long pause—often in the middle of a sentence—or an incomplete thought or statement.) It’s common to type 3 periods in place of an ellipsis (some style guides even prefer 3 periods—especially when using a fixed-width font); however, most modern fonts include an ellipsis character, with a width equal to that of the “M” character in that font. In general, avoid using a period immediately before or after an ellipsis, with no intervening spaces. For example, if the omitted text immediately follows a complete sentence, that sentence would end with a period (or other terminal punctuation), followed by a space, and then the ellipsis.
Conveniently, the substitute character sequence that kramdown translates to the ellipsis is, in fact, 3 consecutive periods (...
). If using a Markdown processor other than kramdown, it may be necessary to use the HTML entity …
; doing so is preferable to using 3 periods that are not converted to the ellipses.
The em dash (so named because it is as wide as the “M” character; it’s the longest of the dash characters in common use) sets off a word or clause from the surrounding text, to add emphasis or signal an interruption. It is often used (in pairs) in place of parentheses, when the enclosed clause is not essential to the surrounding text, but is still more important than parentheses would typically indicate. When an em dash follows some text on the same line, there should not be a space between the preceding text and the em dash. Similarly, when an em dash is followed by text on the same line, there should be no space between the em dash that the text that follows it.
kramdown automatically translates a sequence of 3 hyphen or minus characters (---
) into an em dash. Some other Markdown processors do not support this conversion; when using one of these, the HTML —
entity should be used.
The en dash (which has the same width as “N”) is used between the endpoints of a range of values (e.g. numbers, dates, times). There should be no spaces immediately before or after the en dash.
kramdown automatically translates a sequence of 2 hyphen characters (--
) into an en dash. When using a Markdown processor that doesn’t support this, the –
entity should be used.
The ampersand is used as a shorthand for “and”. It should be used sparingly: acceptable uses include menu or other control text, where space is at a premium; names of products or organizational entities, where the ampersand is part of the formal name; and compound lists, where a single list item may consist of multiple terms, with the ampersand used before the last item in the sublist.
In HTML and XML, &
is a control character, so a literal “&” must be written using the XML/HTML entity &
. Virtually all Markdown engines accept this (and other XML/HTML entities); however, many of them—including kramdown—accept a single &
character, replacing it with &
when the Markdown is rendered as HTML. Thus, while &
and &
are both acceptable, the first is preferred, when possible.