-
Notifications
You must be signed in to change notification settings - Fork 56
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alan Munn
committed
Mar 21, 2021
1 parent
287ec22
commit b33423c
Showing
1 changed file
with
32 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
--- | ||
layout: "page" | ||
lang: "en" | ||
title: Writing Style Guide | ||
permalink: /STYLEGUIDE | ||
--- | ||
|
||
# Style Guide for English Pages | ||
|
||
This document consolidates some of the writing style recommendations that have arisen as the site has been developed. If you are adding new material, please try to observe these conventions so that pages maintain some sort of uniformity. | ||
|
||
## Quotation marks | ||
|
||
- use single quotes for words being mentioned in a sentence that are not part of the sentence. | ||
- use double quotes for actual quotations (e.g. quoting from documentation or a person). | ||
- use double quotes for titles of articles. | ||
|
||
## Italics | ||
|
||
- Use italics for titles of books. | ||
- Use italics for new terms that are being introduced, when they appear with an immediate explanation or definition. | ||
- Use italics for variables inside code. E.g., `\bibliography{*yourbibfile*}` | ||
|
||
## Inline code | ||
|
||
- Use code formatting for things like `pdlaftex`, `bibtex`, `biber` when referring to running the program itself. Use pdfLaTeX, BibTeX, Biber when referring to the program outside of such contexts. | ||
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong.
This comment has been minimized.
Sorry, something went wrong. |
||
- Similarly, use code formatting for package names, when referring to the package specifically. Packages or sets of package that have well-known names such as TikZ or psTricks can be formatted as such when talking about them generally. | ||
|
||
## Spelling | ||
|
||
- Please use US standard spelling conventions. | ||
|
There is an extra space between
Use
andcode
:)