Office for the web Documentation Style Guide

Whitespace guidelines

  • Use spaces everywhere for whitespace. Do not use tabs.

  • Use a single space in between sentences.

  • Tab length: 4 spaces

Heading styles

The Office for the web documentation should use the following characters for header underlines:

  1. ===== (equals sign)

  2. ----- (dashes)

  3. ~~~~~ (tildes)

  4. ^^^^^ (carets)

  5. """"" (double-quotes)

  6. ***** (asterisks)

Overlines should never be used.

Example

Header level 1
==============

Header level 2
--------------

Header level 3
~~~~~~~~~~~~~~

Header level 4
^^^^^^^^^^^^^^

Header level 5
""""""""""""""

Header level 6
**************

Note/admonition styles

Note/admonition sections will be styled appropriately so they stand out from the rest of the text in a section. The standard reStructuredText directives such as ..  note:: can be used, as well as some custom directives using the ..  admonition:: directive. See the below examples for more information.

Examples

Note

This is a note using the ..  note:: directive.

..  note::

    This is a note using the ``..  note::`` directive.

Tip

This is a tip using the ..  tip:: directive.

..  tip::

    This is a tip using the ``..  tip::`` directive.

Warning

This is a warning using the ..  warning:: directive.

..  warning::

    This is a warning using the ``..  warning::`` directive.

Danger

This is a danger message using the ..  danger:: directive.

..  danger::

    This is a warning using the ``..  danger::`` directive.

OneNote for the web Note

This is an OneNote for the web note using the ..  admonition:: directive.

..  admonition:: |onenote-web| Note

    This is a |onenote-web| note using the ``..  admonition::`` directive.

Excel for the web Note

This is an Excel for the web note using the ..  admonition:: directive.

..  admonition:: |excel-web| Note

    This is an |excel-web| note using the ``..  admonition::`` directive.

Office for the web Tip

This is an Office for the web tip using the ..  admonition:: directive.

..  admonition:: |wac| Tip

    This is an |wac| tip using the ``..  admonition::`` directive.

Pre-release Content

This is a pre-release content warning using the ..  admonition:: directive.

..  admonition:: Pre-release Content

    This is a pre-release content warning using the ``..  admonition::`` directive.

Pre-release Feature

This is a pre-release feature warning using the ..  admonition:: directive.

..  admonition:: Pre-release Feature

    This is a pre-release feature warning using the ``..  admonition::`` directive.