Yelp » Mallard »

Mallard Style Hints in Yelp

All elements in Mallard allow a style attribute that takes a space-separated list of style hints. Style hints may affect how a tool processes an element. They are non-normative, and tools are free to support any style hints they choose. Elements may list more than one style hint. In some cases, only a single hint is used. In other cases, hints may be combined.

code/@style = "numbered"
screen/@style = "numbered"

  • The block code and screen elements can both take the "numbered" style hint to show line numbers.

note/@style = ("advanced" | "bug" | "important" | "plain" | "sidebar" | "tip" | "warning")

  • The note element can take any of the preceding hints to determine which icon is used. The special "sidebar" style hint causes the note to be rendered as a non-intrusive box along the side of the text. The "plain" style removes icons and extra accessible information for a simple box with a background color.

list/@style = "compact"
terms/@style = "compact"

  • On list and terms elements, using the "compact" style hint reduces the amount of vertical padding around list items. This is best used for lists of words or short phrases.

list/@style = "continues"
steps/@style = "continues"

  • On list and steps elements, using the "continues" style hint causes the list to start numbering where the previous compatible list left off, just like the DocBook continuation attribute. For a steps element, the previous compatible element is the first preceding steps element. For a list element, the previous compatible element is the first preceding list element with the same type attribute.

tree/@style = "lines"

  • The "lines" style hint on the tree element causes lines to be drawn to show the hierarchy.

media/@style = ("floatstart" | "floatend" | "floatleft" | "floatright")

  • A block media element can be floated to the left or right using the corresponding style hint. You should generally prefer the "floatstart" and "floatend" hints. They behave just like "floatleft" and "floatright", except that they flip automatically for right-to-left locales.

em/@style = "strong"

  • The "strong" style hint on the inline em element makes text bold instead of italic.

keyseq/@style = "hyphen"

  • The "hyphen" style hint on the inline keyseq element causes a hyphen to be used instead of a plus sign as the key separator.

link/@style = "button"

  • The "button" style hint on the inline link element causes the link to look like a button. This should usually be used for action links.

output/@style = ("error" | "prompt")

  • The inline output element can take the style hints "error" and "prompt" to indicate that the text is an error message or the command prompt, respectively. This is most useful inside a screen element.

links/@style = "mouseovers"

  • The "mouseovers" style on the links element provides an image area and displays a thumbnail for each link in that area as you mouse over the link. It uses the e:mouseover element to get the images. The "mouseovers" style will be replaced by the ui:thumbs attribute. Do not use it unless you are tracking Yelp development closely.

links/@style = ("toronto" | "grid")

  • The "grid" style on the links element causes the links to be formatted left-to-right in a three-column grid (two columns in the mobile rendering). The "toronto" style does exactly the same thing, using a less obvious name. This was one of the first links styles added, and it was added during a doc sprint in Toronto. The "toronto" name is historical and nostalgic, while the "grid" name is clearer. Both will continue to work.

links/@style = "norwich"

  • The "norwich" style on a links element causes the links to be formatted as a grid of tiles, designed to be used as the front splash page for the GNOME help. This is a specialty style that may change in future versions.
    Since 3.12

links/@style = "button"

  • The "button" style on the links element causes the links to be formatted to look like buttons.

links/@style = "heading"

  • The "heading" style on the links element causes the links to be formatted large and bold as if they were section headings.

links/@style = "linklist"

  • The "linklist" style on the links element causes the links to be formatted as a simple list. This is the default formatting for "seealso" and "guide" links.

links/@style = "2column"

  • The "2column" style on the links element causes the links to be formatted as link blocks (as is the default for "topic" links), but top-to-bottom in two columns. It collapses to a single column in the mobile rendering.

links/@style = "center"

  • The "center" style on the links element causes links and titles to be centered.

links/@style = "bold"

  • The "bold" style on the links element causes link titles (but not descs) to be bold even in styles where they otherwise would not be, such as in the "linklist" style.

links/@style = "nodesc"

  • The "nodesc" style on the links element causes the link descs not to be displayed in any style where they otherwise would be.

links/@style = ("floatstart" | "floatend" | "floatleft" | "floatright")

  • For "section" and "series" links elements only, these styles causes the links to be be in a box floating to one side. You should generally prefer the "floatstart" and "floatend" hints. They behave just like "floatleft" and "floatright", except that they flip automatically for right-to-left locales.

links(prevnext)/@style = "top"

  • For "prevnext" links elements only, this causes the links to appear at the top of the page, above where links elements would otherwise be placed. Yelp automatically places "prevnext" links at the top and bottom if you do not use a "prevnext" links element. But if you use any "prevnext" links element, it overrides the default. This style is the only way to get the "prevnext" links at the top while also putting them elsewhere.

title/@style = "heading"

  • The "heading" style on a block title element (i.e. not a title of a page or section) causes the title to be formatted large, as if it were a section title. Normally block titles are at the normal font size.

title/@style = "center"

  • The "center" style on a block title element (i.e. not a title of a page or section) causes the title to be centered. Normally block titles are aligned left, or aligned right for RTL locales.

title/@style = "hidden"

  • The "hidden" style on page and section titles causes the title to not be displayed. Titles are mandatory on pages and sections, but occasionally with certain specialty styles, it's useful to hide them.


    Since 3.12

desc/@style = "center"

  • The "center" style on a block desc element (i.e. not one found in an info element) causes the desc to be centered. Normally block descs are aligned left, or aligned right for RTL locales.

DocumentationProject/Guide/Mallard style hints (last edited 2014-06-18 17:28:56 by EkaterinaGerasimova)