Skip to content

Commit

Permalink
Styles: Manually added @FormulatedEdits changes from #40
Browse files Browse the repository at this point in the history
  • Loading branch information
flipacholas committed Aug 18, 2021
1 parent 1a0e0a0 commit 85f176b
Showing 1 changed file with 141 additions and 14 deletions.
155 changes: 141 additions & 14 deletions STYLES.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,154 @@
## Architecture of Consoles Style Sheet (beta)
# Architecture of Consoles Style Sheet (beta)

#### Acronym Expanded Form (AEF)
## General

This is regarded as the best way to expand an initialism or acronym. The first occurence of uncommon acronyms in each article should be explained in this way. (Common acronyms (like CPU) are assumed to be understood by the reader.)
#### Titles

#### Using 'ise'-type British spellings. No capital after colon.
Minimum capitalisation: "This is an example, Playstation 3". Expand acronyms in titles where reasonable.

#### Vocabulary
#### Acronyms

'Writings' - this is an unusual word but it is acceptable, I will not change it as you use it very frequently and have integrated it into your site structure. I consider it part of your voice (from your name I'm guessing there is some Italian/ESL going on, but I could be wrong).
The first use of an acronym within a piece should be expanded as shown: "Acronym Expanded Form (AEF)". Other similar forms are also acceptable (e.g. Acronym Expanded Form, or AEF,..)

"on the fly" – I took the hyphens out of that and another construction in the same paragraph, while adding them in for "in-step"
Where an acronym is used in passing, it needn't be expanded if doing so would clutter the text, as long as its relevance to the point at hand is clear. Inserting an explanatory link is also acceptable.

Using 'waveforms' as it's a common enough word nowadays to drop the hyphen.
Where an acronym is defined later (in a more appropriate place) in the same piece, it's acceptable to say so and defer defining it.

"However" typically has a comma after it – use without a comma is common, but recommended against by the editing community (which is a little more resistant to change than the tech community, as you might imagine). There is a good reason in theory: it's to distinguish between uses like
Common computing acronyms are assumed to be understood by the reader. Examples: KB, GB (etc.), CPU, GPU, RAM, ROM, VoIP, MIDI, MP3, AAC, SDK(?), API(?), D-Pad, USB, DRM.

> However, they survived ("But they survived")
If an acronym is being used far away from its first definition, it is acceptable to remind the reader of its meaning. This can be done in any appropriate way, but the cleanest is to use the full form (with capitals) once, and then return to using the acronym.

and
#### Numbers

> However they survived ("They survived, but we don't know how, and we're about to talk about something else").
Spell from zero up to ten, and at the beginnings of sentences. From 11 onwards and mid-sentence, use numerals. (In practice very few numbers will be spelled. See the exceptions below.)

#### Capitalisation - nouns vs proper nouns
Measurements to be given as numerals (e.g. 4 GB)
Be consistent within sentences – use numerals in such cases (e.g. The 90 giraffes all had only 4 legs each). This can be applied across sentences if a comparison is being made (e.g. The Namibian millipede has 99 legs. The giraffe only has 4).

Making sure to appy capitalisation to proper nouns only.
Do not change proper for nouns (e.g. Playstation 3, not Playstation Three)

~ is acceptable in notes and parentheses.

#### Using 'ise'-type British spellings.

#### Measurements and units

Abbreviations to be spaced (e.g. 60 KB):
- MHz
- MB
- GB
- KB

#### Latin abbreviations

Point between lowercase letters (e.g.)

No following comma (e.g. like this)

Latin abbreviations should be avoided in running text but are acceptable in parentheses, bullet points and captions.

#### Bullet points

Each item to be punctuated with a full stop.

## Punctuation

#### Colon
No following capital (: example).

#### Ellipsis
No leading space (like... this)

#### No Oxford/serial comma
(Except where absolutely needed for clarity)

#### Quotes
Single quotes, with double quotes within (British style). New terms (but not acronyms) in running text (not titles or captions) to be introduced in quotes; otherwise quotes should be used sparingly.

## Vocabulary

#### 'Writings'

Important to author voice. Do not change except where certainly incorrect.

#### "On the fly"

No hyphen.

#### Waveforms

One word, no hyphen.

#### Address bus

Capped down (address bus).

#### "32-bit X"

With hyphen. Same for 12-bit, etc.

The hyphen is kept for a descriptor, but dropped for a measurement (e.g. the 12-bit X holds 12 bits).

#### S-Video

Capitalised S and V.

#### D-pad

Capitalised D.

#### WiFi

No hypen.

#### PSP Specific Vocab

Tachyon, Kirk, Spock

The Allegrex (cf. 'the Core i7')

#### Flash memory

Capital 'F' to distinguish from the usual meaning of flash.

## Guidance

#### "However,"

'However' should always has a comma after it when used like 'but'. This mnemonic shows why:

> However, they survived
"But they survived"

> However they survived
"They survived, but we don't know how, and we're about to talk about something else".

#### Capitalisation

Be ruthless in removing capitalisation. This is particularly important in technical fields, where capitalisation is already more common than usual, and can proliferate with the addition of each new term. Capitals should only be used for proper nouns, acronyms (including where defining them, e.g. Acronym Expanded Form (AEF)), and sentence initials.

#### 'Having said that' and 'that said'

These are usually used to introduce a contrast (e.g. Jack has some bad points, but having said that, he helped me move house.) Where wrapping up and moving on, these might do instead:
- "Now that we've established that,"
- "Bearing that/the above in mind,"
- "Now we know how X works,"
- "Moving on,"

#### Article subject/title reminders

It's a good idea in long web articles to remind the reader of the topic (i.e. which console you're discussing) from time to time.

## Queries and questions:

#### Tenses

(Under consideration)

The tenses jump around a bit in some pieces. It's worth considering standardising this across all pieces, according to a system (perhaps using past tense unless there is a specific reason not to).

#### Bullet points

Some bullet points begin with a bold section that ends in a colon. This section could be regarded as a title of sorts. After such a title it could be regarded as correct to capitalise the initial of the following matter, i.e. cap after colon. I haven't implemented this as it would be inconsistent with other colon usage.

0 comments on commit 85f176b

Please sign in to comment.