Style Guide

This is the style guide that contributors will use to add content to the project.

Before You Contribute

Markup Formatting

This project uses the GitHub Flavored Markdown or GFM for its content formatting. Not familiar with it? Visit http://daringfireball.net/projects/markdown/syntax.

Format

Overall

1. Any place where commands or code is noted, the contributor will use the code markup "```" format.
2. When using the ``` format, please use the syntax highlighting appropriate for that code's language. See https://help.github.com/articles/github-flavored-markdown#syntax-highlighting for details. For instance, if you have a python snippet, you'd use: ```python
if answer == 42; print 'That is life.' ```

Which looks like below when rendered using this format:

if answer == 42; print 'That is life.'

One Liners

For some information, a table is the preferred format. This is best when you have one-liners or short entries that require no extra sample content. In these cases, a simple table can be used to format the data. The table should have at least 2 columns: Command and Description and may have more if desired/warranted. An example of the Markup formatted table is below.

| Command | Description | OS |
| ------- | ----------- | -- |
| `ls` | Lists the files in the current directory. | *nix |

Detailed Entries

Sometimes the content of a page may require additional details that may not look good in a table view. In this case, we use a Detailed Format as described below.

### Windows Finding File Commands
Commands that find files on the filesystem and are usually executed from the context of the `cmd.exe` or `command.exe` prompt.

#### Heading
##### Subheading/Command
 * **Command with arguments**: `dir /a`
 * **Description**: Displays files with specified attributes. Examples: D=Directories, R=Read-only files, H=Hidden files, A=Files ready for archiving, S=System files
 * **Output**:
   * <div class="slide" style="cursor: pointer;"> **Windows 2008:** Show/Hide</div><div class="view"><code>C:\Users\johndoe>dir /a c:\<br> Volume in drive C has no label. Volume Serial Number is 1A09-5F16<br><br> Directory of c:\<br><br>01/19/2008  03:45 AM    <DIR>          $Recycle.Bin<br>09/18/2006  04:43 PM                24 autoexec.bat<br>10/08/2013  10:27 PM    <DIR>          Boot</code></div> 

Content

Overall

1. Make the entries as descriptive as possible. Remember that a wide audience of people will be reading this content. We are writing so that the novice can understand and the expert find value quickly.
2. Reread your content before submitting a pull request. Ensure that there are few spelling errors and the formatting is correct.
3. Provide URLs or links to other authoritative sites that the reader can visit for more information. We say authoritative so that we use links to quality, sites like Microsoft's Technet for Windows commands instead of "My friend Joe's blog". Try to go to the source when possible.
4. Some pages may need multiple tables such as if you have a multiple commands (wmic, net, and ipconfig) that each have multiple entries. In this case, please create a single table for each of the commands and make them in their own sections such as below:

## net
| Command | Description |
| ------- | ----------- |
| `net view [/domain | /domain:OTHERDOMAINNAME]` | Queries NBNS/SMB (SAMBA) and tries to find all hosts in the system's current workgroup. Add the `/domain` option if the current system is joined to a domain. To query a different domain, use the `/domain:OTHERDOMAINNAME` option. |

## wmic
| Command | Description |
| ------- | ----------- |
| `wmic process get caption,executablepath,commandline` | Retrieves process names, captions, executable paths and command line flags. |