Community: Wiki Formatting Guidelines and Conventions

nateemerson edited this page Aug 29, 2011 · 20 revisions
Clone this wiki locally

Content Formatting Conventions

To see exactly how to format content in this wiki, edit this page and look at the markdown code used for the examples

  • When listing HTML entities, use the inline code formatting offered by markdown by using backticks. When describing HTML entities, it is best to include the full tag name each time it is used. Example: " can add header text with a <span> element"

  • When listing CSS accessors such as classes, ids, or pseudo-classes, use bold formatting, denoted in markdown by double asterisks. Example: "To create a header, simply make a new <h1> entity and give it an id of #header."

  • When listing HTML entities with a specific CSS identifier, use the HTML tag with the CSS class/id appended, within the tag. Use markdown's conventional inline code formatting, denoted by backticks. Example: "Within the <> entity..."

  • When displaying example code, use markdown's block code formatting, denoted by a content block bounded by lines of triple backticks. You can specify the language used after the first three backticks to enable language-specific syntax highlighting. Example:

<h1 id="header">
    <a href="http://{MOBILE_DOMAIN}"> 
        <img src="http://{MOBILE_DOMAIN}/assets/img/{LOGO_IMG}" alt="{ALT_TAG}" width="75" height="35">
  • When referencing text segments within code blocks that are intended to be replaced, use bold formatting. Example: "Replace {MOBILE_DOMAIN} with a domain where the MWF is hosted."

  • When listing javascript functions, use Markdown's inline code formatting, denoted by backticks.. Example: "Through the Javascript API, a page can tell if a user is in preview mode via a call to mwf.user_agent.is_preview()."

  • When listing framework file names, use bold formatting. Example: "The js.php file dynamically loads a set of Javascript"

  • When listing Git entities such as branches, use bold formatting. Example: "This version pulls from {institution}/maint and {institution}/develop occasionally to bring in maintenance and feature changes, and it also pulls from master to bring in MWF root changes."

  • When listing HTML content types, use italic formatting. Example: "Though a .php file, this file identifies itself as content-type text/javascript."

  • When listing GET flags, use bold formatting. Example: "The no_icon flag is equivalent to a combination of both the no_favicon and no_appicon flags and thus is is the same as appending both separately"

  • When listing Javascript libraries, use bold formatting. Example: "The mwf.touch.geolocation library (includable as the touch library geolocation) provides a straightforward interface for this purpose"