Difference between revisions of "Style Guide"
From Security Vision
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | <blockquote> This is the Style Guide for this Wiki. To keep the Wiki uniform | + | <blockquote> <span style="color:red> This is the Style Guide for this Wiki. To keep the Wiki uniform, please follow these guidelines. </blockquote> |
=== Deployments === | === Deployments === | ||
| Line 24: | Line 24: | ||
| − | + | ===Cities === | |
* Cities should be named according to their official names. | * Cities should be named according to their official names. | ||
* Cities, for which the English name differs from the original name, use the English name (e.g.The Hague instead of Den Haag) | * Cities, for which the English name differs from the original name, use the English name (e.g.The Hague instead of Den Haag) | ||
* Cities, which are not the biggest/most known city with that name, add an identifying characteristic such as the state or the countries in brackets. (e.g. Cambridge (MA)) | * Cities, which are not the biggest/most known city with that name, add an identifying characteristic such as the state or the countries in brackets. (e.g. Cambridge (MA)) | ||
| − | + | === Countries === | |
* Use the English language country name instead of the official country name (e.g. Germany instead of Federal Republic of Germany) | * Use the English language country name instead of the official country name (e.g. Germany instead of Federal Republic of Germany) | ||
| − | + | === Institutions/Products/Databases === | |
* Use the full name of an institution/products/database instead of its abbreviation. You can add the abbreviation in brackets behind the full name. | * Use the full name of an institution/products/database instead of its abbreviation. You can add the abbreviation in brackets behind the full name. | ||
* Creating a governmental organisation, include the English country name (German Ministry of Foreign Affairs instead of Ministry of Foreign Affairs) | * Creating a governmental organisation, include the English country name (German Ministry of Foreign Affairs instead of Ministry of Foreign Affairs) | ||
Latest revision as of 14:58, 26 August 2022
This is the Style Guide for this Wiki. To keep the Wiki uniform, please follow these guidelines.
Deployments[edit | ]
Deployment titles:[edit | ]
- For titles follow this format: [Company name] [Technology Type] deployment in [City] OR [Country] (For example: Briefcam Video Analytics deployment in Amsterdam)
- Deployment titles should be precise and concise, and an adequate description of the deployment itself.
- Capitalize the initial letter but otherwise follow sentence case.
- Do not capitalize the second or subsequent words in an article title, unless the title is a proper name.
- Avoid ambiguous abbreviations.
- Do not place definite or indefinite articles (the, a, and an) at the beginning of titles unless they are part of a proper name (for sorting reasons).
- When using city names, and the city is not the most known/biggest city with that specific name, add a descriptive characteristics such as the state or the countries in brackets after the city name. (e.g. Cambridge (MA) for an deployment in Cambridge in Massachusetts.)
Free text[edit | ]
- The free text should be used to explain a deployment in more detail and to write a short narrative of the deployment.
- Before blockquotes give a short description about the importance of the quoted text.
- Blockquotes should explain the deployment in more detail and should contribute to the narrative of the deployment.
- Blockquotes do not need to be translated but a short summary should be given before the blockquote if the blockquote is not in English.
Uncertain Information[edit | ]
- Uncertain information should be characterised as either rumoured or speculative. (Refer to the How to section)
- Include a short description about why the information is uncertain and describe possible speculations concisely. Possibly connect the deployments to other deployments/products/institutions/databases
Cities[edit | ]
- Cities should be named according to their official names.
- Cities, for which the English name differs from the original name, use the English name (e.g.The Hague instead of Den Haag)
- Cities, which are not the biggest/most known city with that name, add an identifying characteristic such as the state or the countries in brackets. (e.g. Cambridge (MA))
Countries[edit | ]
- Use the English language country name instead of the official country name (e.g. Germany instead of Federal Republic of Germany)
Institutions/Products/Databases[edit | ]
- Use the full name of an institution/products/database instead of its abbreviation. You can add the abbreviation in brackets behind the full name.
- Creating a governmental organisation, include the English country name (German Ministry of Foreign Affairs instead of Ministry of Foreign Affairs)