Work in progress
From SKYbrary Wiki
Revision as of 07:03, 13 September 2018 by Editor1
First read the article Writing a SKYbrary Article. This article is intended as a deeper and more pragmatic discussion regarding writing conventions, the structure of articles and some tips and example code that will be useful when writing SKYbrary articles.
If the title of an article is to include a commonly recognised abbreviation, always include the full name and add the abbreviation in brackets afterwards, e.g. Instrument Landing System (ILS).
The title of an article should reflect the terminology in use in Europe. Differences in terms between North America and Europe/Rest of World are addressed by ensuring that the North American terms are referred to in the body of the text - this way they will be picked up by search engines. For example take a look at the article on Level Bust; in this case the North American term is highlighted at the top of the article in a larger font like this:
This isn't absolutely necessary - the important thing is to endsure that alternative recognised terminology is referred to at some ;point in the main body text, usually within the Description.
Articles addressing an operational risk should conform to the same generic layout as shown in the exemplar article on Jet Stream. For other articles however, this may not be appropriate. In such cases, the article should always start with a Definition and/or a Description in which you explain what the article is about and also, where appropriate, what it is not about. The main body should then be structured in a logical way finishing with Related Articles (internal links) and Further Reading (external links and Bookshelf items).
Style and Language
SKYbrary articles are closer to an Encyclopaedia entry than a magazine article. The article must avoid references to future events as this makes the article look dated when viewed after those events have taken place. Article are written in UK English.
Maximise the number of internal links within the text; this makes the article, and the site as a whole, more attractive to search engines. Avoid external links if possible as they may change and result in a broken link.
Documents and presentations can be uploaded onto the Bookshelf. The title of the Bookshelf entry should be exactly the same as the title of the document in order to aid discovery. The author should usually be the publishing authority but an article within a magazine, or a presentation from a conference should list the author. For example, the full copy of a HindSight magazine will list EUROCONTROL as the "author" but individual articles within the magazine will list the author(s) of the article as the "author". The description of the Bookshelf item should include information that will aid discovery if the subject matter is not obvious from the title of the document.
Images on SKYbrary are presented in the following way:
When uploading images, ensure that the size of the image is below 1mb in size.
Constructing tables is complex and takes a certain amount of patience. Here is an example of a tables whose code can be used as a template:
|A (a)||· −||B (b)||−· · ·||C (c)||−· −·||D (d)||−· ·|
|E (e)||·||F (f)||· ·−·||G (g)||− −·||H (h)||· ·· ·|
|I (i)||· ·||J (j)||· − − −||K (k)||− · −||L (l)||· − · ·|
|M (m)||−−||N (n)||−·||O (o)||− −−||P (p)||· −−·|
|Q (q)||−−· −||R (r)||· −·||S (s)||·· ·||T (t)||−|
|U (u)||·· −||V (v)||· · · −||W (w)||· − −||X (x)||− · ·−|
|Y (y)||−· − −||Z (z)||−−· ·|
|1||· − −−−||2||·· −−−||3||· ·· −−||4||··· · −|
|5||· · · · ·||6||−· · · ·||7||− −· · ·||8||− −−· ·|
|9||− −−−·||0||− −−−−|
|Period [.]||·− ·− ·−||Comma [,]||− − ··− −||Question [?]||· · − −· ·||Exclamation [!]||·− ·− − −|
|Parenthesis Open [(]||− ·− − ·||Parenthesis Close [)]||−·− − ·−||Colon [:]||− − −· · ·||Semi Colon [;]||− · − ·− ·|
|Start||−· −· −||End of Work||· · · −· −||New Page||· −· −·||Wait||· −· · ·|
|Understood||· · · −·||Error||· · · · · · · ·|