To get updates on new site content, like us on Facebook or follow us on Twitter.

Difference between revisions of "Help:Style Guide"

From JFA Wiki
(→‎THE REST)
(→‎THE REST)
Line 180: Line 180:
 
**The carnist needs a Band-Aid for his hurt ego.
 
**The carnist needs a Band-Aid for his hurt ego.
 
**The carnist needs a bandaid for his hurt ego.
 
**The carnist needs a bandaid for his hurt ego.
 +
 +
===== Measurements with units =====
 +
*Use numerals, not written-out numbers
 +
**'''We held 20 kilograms each'''
 +
**We held twenty kilograms each
 +
*Use the International System of Units; if space allows, put the imperial equivalent in parentheses
 +
**'''Our TVs are only 30 centimeters (1 foot) across'''
 +
**Our TVs are only 30 centimeters across
 +
*Spell out units when possible
 +
**'''The Cube space was 3 meters by 3 meters'''
 +
**The Cube space was 3 m by 3 m
 +
 +
===== Numbers =====
 +
*Write out numbers 0–9
 +
**'''Seattle had five volunteers.'''
 +
**Seattle had 5 volunteers.
 +
*Write numbers 10+ as numerals
 +
**'''We’ve planned 21 Cubes.'''
 +
**We’ve planned twenty-one Cubes.
 +
*For numbers 100+, either write out or use numerals (depending on whichever seems most impactful for the exact context)
 +
**'''100 PIGS RESCUED; 17,000 MORE TO COME'''
 +
**ONE HUNDRED PIGS RESCUED; SEVENTEEN THOUSAND MORE TO COME
 +
**'''We’ve reached ten trillion followers.'''
 +
**We’ve reached 10,000,000,000,000 followers.
 +
*Numbers at the beginning of sentences should be written out
 +
**'''Twelve months ago, AV first launched.'''
 +
**12 months ago, AV first launched.
 +
*In a sequence of similar numbers, write all numbers as numerals
 +
**'''This week, we got 3, 4, and 15 tallies.'''
 +
**This week, we got three, four, and 15 tallies.
 +
**This week, we got three, 4, and 15 tallies.
 +
**This week, we got 3, four, and 15 tallies.
 +
**This week, we got three, four, and fifteen tallies.
 +
*For negative numbers, us a minus sign (−), not a standard keyboard hyphen (-)
 +
**'''I give −8 cares.'''
 +
**I give -8 cares.
 +
 +
===== Percents =====
 +
*Use the percent symbol instead of spelling out “percent”
 +
**'''Volunteer count increased by 50% this year.'''
 +
**Volunteer count increased by 50 percent this year.

Revision as of 01:43, 12 February 2019

Accepted Guides

  • The Chicago Manual of Style (17th Edition) is our main style guide.
  • Merriam Webster’s Unabridged Dictionary is our source for spelling.
  • Rules may be borrowed from the AV Style Guide and documented herein.

If a rule conflicts with what is generated by standard wiki markup, and if overcoming that standard markup would result in extra work, consider using the wiki convention and documenting that here.

Exceptions

  • Numbers
    • Use CMOS Alternate Rule:
      • ”Many publications, including those in scientific or journalistic contexts, follow the simple rule of spelling out only single-digit numbers and using numerals for all others (but see 9.7). Most of the exceptions to the general rule (9.2) also apply to this alternative rule. Round multiples of hundreds, thousands, and hundred thousands, however, are typically expressed as numerals when the alternative rule is in force (cf. 9.4).”

READ THIS FIRST

The Chicago Manual of Style (17th Edition) is JFA's main style guide; therefore, most of JFA’s style will not be listed here. However, since this page lists both a) style decisions unique to JFA and b) all the ways in which JFA’s style deliberately diverts from the CMOS, this page always takes first priority.

  • For spelling, use the first spelling entry in the online Merriam-Webster Collegiate Dictionary. This can be found (with subscription) by traveling to http://unabridged.merriam-webster.com/ and selecting Collegiate via the Reference drop-down menu. Exceptions are listed below, in the TERMINOLOGY section.
  • If that dictionary doesn’t contain a term or all a term's necessary information (e.g., spelling for plurals, verb endings, etc.), consult the online Merriam-Webster Unabridged Dictionary (also requiring subscription) via the same link but with Unabridged selected in the drop-down menu.

Bold text examples represent the correct way to style text. Non-bold text examples (which generally appear beneath bold ones) represent incorrect ways to style text.

PUNCTUATION

Apostrophes
  • Use curly apostrophes, not straight ones
    • I can’t believe you don’t like seitan!
    • I can't believe you don't like seitan!
Colons
  • Using a colon after an introductory sentence fragment
    • If what comes after the colon is a full sentence, capitalize after the colon
      • Note: These are words.
      • Note: these are words.
    • If what comes after the colon is not a full sentence, lowercase after the colon
      • Example: sheep.
      • Example: Sheep.
Commas
  • Use a comma before “too” (when meaning “also")
    • And we want to see you there, too!
    • And we want to see you there too!
    • And you, too, are appreciated.
    • And you too are appreciated.
    • Don’t waste too much time!
    • Don’t waste, too much time!
  • Use a comma before “either” (when appropriate)
    • We shouldn’t waste time, either.
    • We shouldn’t waste time either.
    • I can’t tell if either is joking.
    • I can’t tell if, either is joking.
  • Use a comma before “also” (when appropriate)
    • We’ll be stopping in New York, also.
    • We’ll be stopping in New York also.
    • We’ll also be stopping in New York.
    • We’ll, also be stopping in New York.
  • Do not use a comma before “as well”
    • I need a mask as well.
    • I need a mask, as well.
Ellipses
  • Use them sparingly
  • Use an unspaced ellipsis character (ALT+0133)…
    • at the end of a complete sentence that is trailing off
      • Speciesism has seen its end…
      • Speciesism has seen its end….
      • Speciesism has seen its end. . .
      • Speciesism has seen its end . . .
      • Speciesism has seen its end...
    • at the end of an incomplete sentence that is trailing off
      • But I don’t think we…
      • But I don’t think we....
      • But I don’t think we. . .
      • But I don’t think we . . .
      • But I don’t think we...
    • at the beginning of a sentence that has an initial dramatic pause
      • We are AV. …Expect us.
      • We are AV…Expect us.
      • We are AV. ….Expect us.
      • We are AV….Expect us.
      • We are AV. . . .Expect us.
      • We are AV . . . Expect us.
      • We are AV. ...Expect us.
      • We are AV...Expect us.
    • in the middle of a sentence when a distinct pause is desired
      • It’s time…that we got serious.
      • It’s time….that we got serious.
      • It’s time. . .that we got serious.
      • It’s time . . . that we got serious.
      • It’s time...that we got serious.
      • It’s time … that we got serious.
      • It’s time… that we got serious.
      • It’s time …that we got serious.
Exclamation points
  • Never use more than a single exclamation point in a row
    • Let’s make some vegans!
    • Let’s make some vegans!!
    • Let’s make some vegans!!!
    • Let’s make some vegans!!!!!!!!!!
Multiple punctuation marks
  • Use “?!” and never “!?”
    • What do you mean?!
    • What do you mean!?
    • What do you mean?!!
    • What do you mean!??
Question marks
  • Never use more than a single question mark in a row
    • Who’s ready to make history?
    • Who’s ready to make history??
    • Who’s ready to make history???
Quotation marks
  • Use curly quotation marks (the default for Google Docs), not straight ones
    • I said, “I’ll never miss a Cube.”
    • I sad, "I’ll never miss a Cube."


THE REST

Dates
  • For days of the month, use ordinal numbers
    • My birthday is September 28th.
    • My birthday is September 28.
  • Spell out month names if possible; abbreviate only if necessary
    • AV’s first ICD was on November 5th, 2017.
    • AV’s first ICD was on Nov. 5th, 2017.
  • Avoid using the slash format (since US and UK reverse the order); if a numbers-only format is required, use ISO, which is YYYY-MM-DD
    • Cube of Truth, Nov. 3rd, 2018
    • Cube of Truth, 2018-11-03
    • Cube of Truth, 11/3/2018
    • Cube of Truth, 3/11/2018
  • Include the year with every date (unless the year is implied)
    • Our day with the most tallies was on November 3rd, 2018.
    • Our day with the most tallies was on November 3rd.
    • Last year, ICD was on November 5th.
    • Last year, ICD was on November 5th, 2017.
  • Use BCE and CE, not BC and AD
    • The Old Testament was written in XX BCE; the New Testament, in XX CE.
    • The Old Testament was written in XX BC; the New Testament, in XX AD.
Internationality
  • Avoid words that are generally only used in limited countries
    • Use the restroom before the demo.
    • Use the loo before the demo.
    • Use the washroom before the demo.
  • Avoid words that would have undesired or unclear meanings in other countries
    • After the Cube, we came home drunk.
    • After the Cube, we came home angry.
    • After the cube, we came home pissed.
  • Include the country when mentioning a city
    • AV was founded in Melbourne, Australia.
    • AV was founded in Melbourne.
  • Include at least the state (written out or abbreviated) when mentioning a US city
    • Next in the tour is Seattle, Washington.
    • Next in the tour is Seattle, Washington, USA.
    • Next in the tour is Seattle, USA.
    • Next in the tour is Seattle.
  • When mentioning an AV chapter, write only “AV:” plus the city name
    • AV: Melbourne kicked ass!
    • AV: Melbourne, Australia kicked ass!
  • Also see the Temperature section
Latin
  • Avoid Latin constructions; use English equivalents instead
    • I hate animal products—for example, meat, dairy, eggs…
    • I hate animal products (for example, meat, dairy, eggs)…
    • I hate animal products—e.g., meat, dairy, eggs…
    • I hate animal products (e.g., meat, dairy, eggs)…
    • I hate animal products, e.g., meat, dairy, eggs…
Legality
  • Avoid trademarked terms
    • The carnist needs a bandage for his hurt ego.
    • The carnist needs a band-aid for his hurt ego.
    • The carnist needs a Band-Aid for his hurt ego.
    • The carnist needs a bandaid for his hurt ego.
Measurements with units
  • Use numerals, not written-out numbers
    • We held 20 kilograms each
    • We held twenty kilograms each
  • Use the International System of Units; if space allows, put the imperial equivalent in parentheses
    • Our TVs are only 30 centimeters (1 foot) across
    • Our TVs are only 30 centimeters across
  • Spell out units when possible
    • The Cube space was 3 meters by 3 meters
    • The Cube space was 3 m by 3 m
Numbers
  • Write out numbers 0–9
    • Seattle had five volunteers.
    • Seattle had 5 volunteers.
  • Write numbers 10+ as numerals
    • We’ve planned 21 Cubes.
    • We’ve planned twenty-one Cubes.
  • For numbers 100+, either write out or use numerals (depending on whichever seems most impactful for the exact context)
    • 100 PIGS RESCUED; 17,000 MORE TO COME
    • ONE HUNDRED PIGS RESCUED; SEVENTEEN THOUSAND MORE TO COME
    • We’ve reached ten trillion followers.
    • We’ve reached 10,000,000,000,000 followers.
  • Numbers at the beginning of sentences should be written out
    • Twelve months ago, AV first launched.
    • 12 months ago, AV first launched.
  • In a sequence of similar numbers, write all numbers as numerals
    • This week, we got 3, 4, and 15 tallies.
    • This week, we got three, four, and 15 tallies.
    • This week, we got three, 4, and 15 tallies.
    • This week, we got 3, four, and 15 tallies.
    • This week, we got three, four, and fifteen tallies.
  • For negative numbers, us a minus sign (−), not a standard keyboard hyphen (-)
    • I give −8 cares.
    • I give -8 cares.
Percents
  • Use the percent symbol instead of spelling out “percent”
    • Volunteer count increased by 50% this year.
    • Volunteer count increased by 50 percent this year.
Retrieved from "https://justiceforanimals.org/index.php?title=Help:Style_Guide&oldid=1557"