Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Words to Style Guide / Spelling Reference #36

Closed
sypets opened this issue Nov 29, 2018 · 4 comments

Comments

@sypets
Copy link
Contributor

commented Nov 29, 2018

Add some terms that are commonly used in the docs to Content Style Guide & Spelling Only add terms where spelling is currently inconsistent or not obvious.

  • Since spelling in title (headlines) follows different rules, here we focus on how words are spelled when not in title.
  • Because the spelling can differ from context to context: Try to add additional context as example sentences, how the term might be used in a sentence or phrase or link to a good example for usage.

Current best choice in bold.

  • "backend" (alternate spellings, discouraged: "back-end", "back end")
    • possible rule: "backend" if used as general backend, "Backend", if used in the sense of the TYPO3 Backend
    • example: "When you log into the backend, make sure to ..."
    • see frontend in this list
  • "Code Sprint", "code sprint"
  • The product Composer is a proper noun and is capitalized, so use that unless you explicitly mean the command composer (see Tools with Executables)
  • extension.
  • "Extension Manager" or "extension manager"?
  • Fluid
  • frontend if used in the context of general backend, "Frontend" if used in context of the TYPO3 Frontend, front-end, Front-End, Front End, front end (as noun)
  • GitHub
  • "Introduction Package" or "introduction package"
    • Example usage: “Look for an introduction package to get started” vs “The official TYPO3 Introduction Package is a great place to start”
    • uppercase or lowercase depends on context
  • Quickstart / Quick Start / quick start / quickstart
  • reST
  • "sitepackage" (not "Site Package", "site package")
  • (the) "TYPO3 Core" or "TYPO3 core"
    • Example usage: "The TYPO3 Core comes with a number of icons that may be used in your extension."
  • ViewHelper, (not viewhelper, view helper)
    • Use viewhelper, unless you are referring to something that is explicitly spelled ViewHelper (e.g. the directory.
  • see also #37

Additional information

capitalization

The most problematic question here (besides the question of one word, two words or hyphenated words, e.g. front-end) is captitalization, e.g. backend or Backend: In general, the trend is to write lowercase, even for specific technical terms, e.g. the internet, see The Verge: AP Style Guide will no longer capitalize internet. In the case of backend: menu is spelled lowercase, why should backend be capitalized?

References

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Dec 17, 2018

See also comments in Slack.

sypets added a commit that referenced this issue Jan 2, 2019

Add clarifications to content style guide
- list of words for title spelling
- simplified section for title spelling
- add rule: when referring to GUI elements, use same spelling
- add list of references
- add more terms to spelling reference

Resolves: #41
Related: #36

sypets added a commit that referenced this issue Jan 3, 2019

@mabolek

This comment has been minimized.

Copy link

commented Jan 4, 2019

Backend is a dictionary word, and not a name, so I would write it lowercase. When you say "logged in to the backend", it could be any backend, just as you can "log in to the online gaming platform". I would only use uppercase if I wanted to emphasize the (one and only) TYPO3 Backend.

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jan 4, 2019

See Slack for discussion on "site package or sitepackage". It has been decided now to use sitepackage. That's what was also originally used by Benjamin Kott in his early publications and used on sitepackage builder page.

todos:

  • I will try to summarize the reasons for writing this in one word and add another small section for spelling of compound words.
  • spelling should be changed in sitepackage tutorial.

@sypets sypets closed this in 1f6b575 Jan 4, 2019

@sypets

This comment has been minimized.

Copy link
Contributor Author

commented Jan 6, 2019

sypets added a commit that referenced this issue Jan 16, 2019

sypets added a commit that referenced this issue Jan 19, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
2 participants
You can’t perform that action at this time.