View a printable version of the current page.
  Wiki > Symbian Developer Network Public Wiki > ... > Books > Symbian Style Guide
  Symbian Style Guide
Added by jostichbury, last edited by jostichbury on Aug 12, 2008  (view change)
Labels: 
(None)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Acronyms and Abbreviations


If an abbreviation comes at the end of a sentence, do not add another period. Example: The news paper The News of the World is owned by News Corp.

Do not use periods in abbreviations unless part of the actual name. Example: US Robotics not U.S. Robotics and UK not U.K.

Acronyms should be written in uppercase when they are formed from initials of three letters or less, or if you can't say it as a word (USB). When written out in full, the initial letter of each should be lowercase unless it is a proper name (for example, universal serial bus).

Acronyms of four letters or more, and those that you can say as a word, should have only the first initial uppercase (such as Nato or Nasa). Periods are not used in acronyms and they are not terminated with a period, unless they come at the end of a sentence.

When pluralizing acronyms, do not use apostrophes. Example: 60s not 60's and IDs not ID's.

Words that have been shortened, but still retain their first and last letters do not need a period after them. Examples: Dr, Mr and Ltd, not Dr., Mr. and Ltd.

Ampersand


Remove all ampersands (example: Terms and Conditions not Terms & Conditions) unless they appear in a company name. Examples: John Wiley & Sons, Marks & Spencer, Black & Decker.

Audience


Consider our target audiences.

Example:

  • Akimoto-san, who works for a Japanese hardware company, is not a native English speaker.
  • Betty, a systems engineer working for Nokia. She has written Linux device drivers for 4 years and now wants to write them for Symbian OS.
  • Cecil, a computer science undergraduate. He is fairly new to OS terminology, and gets confused when different people give words different meanings.
  • Derek, a very experienced systems engineer. He knows many other operating systems back to front, but not Symbian OS.

Write clear, simple English. Never use a long word where a short one will do. If you can cut a word out, cut it out.

Avoid idiom. Terms such as 'sea change', 'writing on the wall', 'at the end of the day', are meaningless to readers whose second language is English. Attempt to write in the most simple and direct manner that you can: this is a textbook, not a novel.

Do not refer to your readers in the third person. Referring to developers/the reader use 'we' to refer to activities that you are sharing (for example, coding) or 'you' for activities that they can go away and do independently - rather than, 'a developer could then do X'.

Although regurgitating pre-written literature makes writing easier, remember that your target audience will already have access to, and most probably read any literature which Symbian make publicly available. Try to exceed the information contained in this literature, either by adding clarity or by adding further detail.

Box-outs


If box-outs are used, they should be used consistently or not at all. That is, there should not be a book that has a few chapters with many, and the remainder with none. There should be some evenness of spread throughout the work. Try to avoid using too many box-outs, especially in shorter work, as they break the flow of the text.

This is a box-out. Slightly indented. Slightly smaller font. Boxed.

Capitalization


Numbered headings, and chapter headings, have initial capitals for all major words.

Minor, unnumbered headings, capitalize the initial letter of the first word only.

For more information, refer to the Headings section.

When referring to other chapters, or sections within a chapter capitalize the word 'chapter' and the word 'section'

Examples:

See Chapter 6 for more details.

See Section 5.4 for more details.

When citing a figure or table, capitalize the word 'figure.'

Example: See Figure 1.2 for a graphical illustration of the sales figures on Europe.

When demonstrating text that is typed onto a command line, the text should be all lowercase and in code font. 

Example:

abld build winscw udeb

not

Abld build winscw udeb

URLs and filenames should be given in lowercase as much as possible. If the
filename is long; it may make sense to use capitals for readability. Example: Please check the contents of filename.doc for further information. But Please check the contents of thisFilenameIsLong.doc for further information.

If the file system is case sensitive, make sure that your filename is valid. If the filename has an accepted capitalization then use it.

Do not over capitalize. Use capitals for proper nouns only.
Example:
But Tony has been to Tesco and bought the drinks.
not But tony has been to tesco and bought the drinks.

I believe that platform security is the most important area to focus on.
not I believe that Platform Security is the most important area to focus on.

Some more examples to help:
a leave not a Leave
an active object not an Active Object.

Citations

See References and Citations.

Code

  • In books where space is limited, indent code by two spaces. In other publications, if there is no restriction on space, then use four spaces or a tab.
    Example:
    //An example
    abc::defg()
      {
      apieceofcode();
      if(something)
        {
        somemorecode(); }
        }
      }
    
    class CMyClass : public CBase
      {
    public:
      static CMyClass* NewL();
      ~CMyClass();
    protected:
      CMyClass();
      void ConstructL();
    private:
      HBufC* iMyBuf;
      };

    Do not include any formatting in your code (e.g. bold or italics) unless it is absolutely necessary to make a point. Beware when copying code directly from Carbide.c++ and pasting it into Word. It will routinely end up with colours, bolds and italics. It is better to use the "Paste Special - unformatted" option when transferring code in this way.

  • Align broken text in comments.
    Example:
    abc::defg()
    {
    apieceofcode(); // An example of a comment that
                               // is broken and aligned over three
                               // lines. Blah blah blah blah.
    { somemorecode(); }
    }
  • Merge broken lines of code where possible (often this is only possible to correctly gauge after typeset)
    Example:
    Instead of
    //postpone message handling to, transition from
    //standby();

    use

    //postpone message handling to, transition from standby();
  • When code within a code box must be broken, right align it beneath the preceding line.
    Example:
    //code that is too long for one line, break it like this so
    //that it is consistent
  • If code must be broken in a code box, try to break at a comma.
    Example:
    //if code is too long for one line aim to break it at,
    //the comma
  • Lines of code within a code box have no space between one another. If a gap is needed then leave a blank line, do not adjust the paragraph alignment.
    Example:
    //This is the first line of code
    
    //This is the second, separated by a blank line
    
    //Do not separate two lines like this
    //By adjusting the paragraph settings
  • When a code word breaks within normal text (this generally emerges when a text is typeset), hyphenate it.
  • When quoting code keywords in text, use the font appropriate for displaying code (often Courier New). When quoting functions or methods, use () to follow the name, regardless of whether that function takes parameter values or not.
    Example:
    "You must call Format() and pass in the appropriate parameter values".

Comma

See Punctuation.

Contractions

See Acronyms and Abbreviations.

Copyright

See Trademarks

Dates and Times


Dates should be written as 'date month year' - in that order with no comma. Example: 2 July 2008 .

If a day is given, the date should be in the order 'day, date month year' with a comma after the day. Example: Monday, 9 July 2003.

Refer to a year by number only. Example: Peter was born in 2004 not Peter was born in the year 2004.

Always use the full names of the days of the week and of months, unless you need to shorten them to fit into a diagram or table. In that case shorten the names to the first three letters only (Mon, Tue, Wed, Thu, Fri, Sat, Sun and Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec).

Use the 24 hour system when reporting times (examples: 09:00 or 18:00) to avoid having to use am or pm. The time zone can be added for clarity (example: 22:00 BST).

Diagrams and Tables


When using diagrams they should all be labeled as follows:
Figure 1.1   Figure title

The first number before the decimal point is the chapter number and the number after the decimal point the number of the figure.

The label should go below the figure.

Every figure must be cited within the text, close to where it is used. When citing the figure, capitalize the word 'figure.
Example: As you can see from Figure 1.2, the inheritance hierarchy follows the standard...

For readability, do not reduce diagrams so that the font is less than size 8. If it is necessary to reduce the size of the diagram to fit to a page then the diagram should be redrawn or split into two.

Please be aware that Symbian Press has a set of guidelines for diagrams. We will use these guidelines to standardize figures.

Tables should be of a consistent style. Column headings should be bold. Any shading or other unique variation in a particular table should be for an explicit purpose.

Every table should be labeled in order to identify it. The number before the decimal point is the chapter number and the number after the decimal point is the table number. The label should go at the top of the table.

The table number must be cited in text close to where the table is located, and the word 'table' should be capitalized. Example: As you can see from Table 5.1, the date of birth of our esteemed team leader occurred during a period of great innovation in British popular music:

Table 5.1 An Example Table

Name Date of Birth Sex
Freddie Gjertsen 16 August 1980 Male

Please supply all images you'd like to include as separate files (JPEG, Visio, or similar) - that is, not solely as images embedded in the Word document. If you do not have any graphics packages, feel free to supply your diagrams as pen and paper drawings - we will redraw them electronically.

Ellipses

See Punctuation.

Figures

See Diagrams and Tables

File Names and Extensions


When referring to a file name, give it in Courier New font or the or the 'filename' style in the template for papers. Example: video.bmp.

When referring to a file type in normal text use all capitals, do not use Courier New font and do not place a period before it. Example: BMP file not .BMP file or bmp file.

First Person


With a single author book, refer to yourself as 'I' and on a multi-author book refer to yourself as 'we'. This helps chapters to have a standard style. Example: we will explain...

Foreign Languages

See Latin and Foreign Languages.

Future Tense

See Tenses

Gender


Use gender-neutral or all-inclusive terms, rather than terms using man and similar masculine terms, to refer to human beings. When necessary to avoid using gender specific terms, rewrite material in the second person (you) or in the plural. Use 'he or she' and 'his or her' infrequently and only if nothing else works. Do not use a plural pronoun such as 'they' or 'their' with a singular antecedent such as everyone.
Forum Nokia Style Guide

We aim to follow these guidelines, given in the Forum Nokia Style Guide. However, do not adjust your text at the expense of making it difficult to understand or contorted, since the occasional use of gender specific pronouns are sometimes unavoidable.

Avoid using the generic masculine pronoun. Example: use 'a user can change the display settings,' instead of 'a user can change his display settings.'
Do not use 'man' or other masculine terms to refer to people, use inclusive or gender neutral terms instead.
Examples:
not chairman, but chair or moderator
not man or mankind, but humanity, people or humankind
not man-made, but synthetic or manufactured.

For further guidance, see 'Bias-Free Communication' in the Microsoft Manual of Style or add a comment to your document for the attention of your copy editor.

Headings


Where headings are numbered with levels to indicate the appropriate section or sub-section, every major word should be capitalized. Where unnumbered sub-headings are used, only the first word is capitalized.For example:

2.1 The Owl and the Pussy Cat

Some text...

2.1.2 Went To Sea in a Beautiful Pea Green Boat

Some more text...

They took some honey

Some more text...

'However'


The correct punctuation of 'however' can be uncertain. As a rule-of-thumb read any sentence aloud to gauge its punctuation. Some assistance:

  • As an aside, between 'mini-brackets.' Example: The analysis made within this report, however, concluded that there is very little difference between the two approaches in practice.

In this case, you can lift out the word 'however' and the sentence reads perfectly well.

  • At the beginning of a new sentence which contradicts the previous one. Example: Numerous references can be found to the environmental benefits of water transport. However, there are few specific studies defining the benefits that water transport has over other modes.
  • It is ungrammatical to use the construction given above without the full stop. Example: We have had a poor year and failed to achieve our profit target, however we have decided to give all staff two extra days off over Christmas to acknowledge their hard work in difficult trading conditions.
  • Note that however is used without a second comma in some circumstances.
    Example: They were ready, however the cards fell.

'How to'


Use 'how to' not 'How To' or 'how-to'
The MS Manual of Style reads as follows: how-to vs. how to. Do not use how-to as a noun, but hyphenate it when used as an adjective.
Whether how to is hyphenated or not, do not capitalize to in titles.
Correct:

  • how-to book
  • How to Format Your Hard Disk
  • I'm writing a How-to Article.

Incorrect:

  • The TechNet Web site has how-tos for system administrators.

Hyphenation


There are no hard-and-fast rules for the usage of hyphens. In general use them when your meaning would be made unclear by not using one.

Here are some guidelines summarized from the Oxford Pocket Fowler's Modern English Usage (2004):

  • Use a hyphen in a compound expression to help convey the unity of the phrase (example: load-bearing or punch-drunk) or when the compound comes before a noun. Example: high-performance gameplay or good-night kiss.
  • Use a hyphen to join a prefix to a proper noun. Example: un-Symbian or non-Newtonian fluid.
  • Use a hyphen to avoid misunderstanding. Example: 'twenty-odd people' means 'about twenty people', but 'twenty odd people' means 'twenty people who are odd.'
  • Use a hyphen to make a distinction about the use of a prefix. Example: 'They recovered the gold from the wreck' means 'They got the gold back from the wreck' but 'I am going to re-cover the sofa' means 'I am going to put a new cover on the sofa.'
  • Use a hyphen to clarify compounds the start and end with the same letter. Example: co-operate, re-enter, un-natural.
  • Use a hyphen to show a common element in a list of compounds. Example: in eighteenth-, nineteenth-, and twentieth-century architecture.

Here is another example to help you:

High-end is hyphenated when used as a compound adjective before a noun, (example: A number of Symbian smartphones are high-end devices), but not hyphenated when used as a simple adjective. Example: A number of Symbian smartphones are devices which are high end.

Use for similar words such as high( - )performance, high( - )quality, high( - )volume and up( - )to( - )date (although update is one word).

If in doubt consult a style manual such as the Chicago Manual of Style (or leave a comment in your document for the attention of your copy editor) and heed the advice from Richard Harrison:

...Common sense suggests that the hyphen is not needed if there is no possibility of misinterpretation, and I would argue that, in computing, many technical terms fall into this category. As a case in point, let us consider 'the window server'. We are talking about a server, so 'server' is a noun. It is qualified by 'window' in order to specify which of many possible servers we mean, so 'window' is being used in an adjectival sense. Clearly, no hyphen is needed and, indeed, inserting one is wrong.

But what about 'a window server utility'? Here we are talking about a utility, not a server, so both 'window' and 'server' are qualifying the type of utility. The utility is neither a window nor a server, so the grammatical rule suggests that we should write 'window-server utility'. But just a minute; is it likely that anyone reading 'window server utility' in a software text will think,  'Ah yes, this is a utility that is both a server and a window'. I don't think so.

If there is no likelihood of the reader being confused, what is the point of hyphenating words in such cases? The only justification that I can think of is the rigid application of a rule of grammar. As far as I am aware, the trend in modern English is to treat rules as guidelines that can be broken. How many people do you know who strive never to split an infinitive? And how many people find that ending a sentence with a preposition is something up with which they will not put?

I put the case that mindlessly following a rule that results in text being peppered with hyphens is counter-productive, particularly when their absence has not the slightest detrimental effect on comprehensibility.

International English


Write using US English. For example, most --ise words should end in --ize (as in authorize, not authorise); --our becomes --or (as in color not colour) and s often changes to z (organisation becomes organization)

Also note that periods and commas go INSIDE quotes in US English, even if they are not part of the original quoted material.
Example: 'To be,' he said, 'or not to be, well really, that is a poser isn't it?'

For more information see Merriam-Webster

Images

See Diagrams and Tables.

Italics


Italicize TV programs, book, magazine, journal names, film titles and URLs. Examples: The Economist, Doctor Who, Pride and Prejudice, New Scientist and Casablanca. Don't italicize anglicized foreign words (Example: ad hoc and de facto, not ad hoc and de facto)

Jargon


Avoid 'verbing' nouns. Only use these in quoted text. Example: missioning, roadmapping, whiteboarding should not be used.

Avoid 'management-ese.' Do not use vogue phrases that managers tend to litter their speech with. Example: not John is going to action a viable thirst solution, use John is going to make a cup of tea.

Job Titles


Don't over capitalize (example: John is the head of marketing at Symbian not John is the Head of Marketing at Symbian). If you are quoting someone's job title, if possible, ask them for their preference, and use that throughout. However you decide to proceed, be consistent, and refer to the same person by the same job title and capitalize job titles in the same way throughout.

Latin and Foreign Languages


Use the full English phrase rather than Latin abbreviations. So, instead of e.g., or i.e., (never eg or ie) prefer to use 'for example,' or 'that is,'.
Avoid the use of foreign language phrases that have not been anglicized. Example: cause célèbre or voilà can be used, but not any lesser-known phrases.

Lists


This is a common area of confusion. Numbered lists should only be used when they denote a sequence of tasks or ordering that cannot be modified, such as step-by-step instructions. All other unordered lists should have bullet points.

With simple lists, subsequent to a colon only place a period (.) after the last list item, and start each item with a lowercase letter (as if continuing a sentence). If list items are more substantial and form discrete sentences, or not subsequent to a colon, complete each with a period (.) and capitalize the initial letter.

Here is a sample list:

  • starts with lowercase
  • has no period here
  • but does here.

Here is another list:

  • The items on this list are longer than the previous one.
  • The items form complete sentences.
  • In this case we start with a capital letter, as you can see.
  • Then we end each item on the list with a period.

Names and Proper Nouns


Carbide.c++
never just 'Carbide'. Note the lowercase c++. Where appropriate, quote the edition (e.g. Developer Edition) and version (e.g. v1.3)

Developers
Symbian developers or Accredited Symbian Developers, not Symbian S60/UIQ/MOAP devlopers or Certified Symbian developers

EPOC
The word EPOC or EPOC32 should not be used except in file paths or when explaining something that is legacy prior to Symbian OS. All such uses should be flagged for approval.

Game names
Game names are given in bold italics.Example: SPORE, Grand Theft Auto. When referring to a game, please check the legal information required to be stated in the preliminary copyright information. For example 'Pathway to Glory and System Rush: Evolution are trademarks or registered trademarks of Nokia Corporation'

N-Gage
Hyphenated, but never split across 2 lines. Capitals as shown. Must always be followed with a specifier such as 'game deck' or 'platform' or 'device' (not capitalization of these too - use lowercase)

Phones
These should be named rather than just given numbers. So it's a Nokia N95 or a Nokia N73, not just a N95 or N73. Likewise Sony Ericsson P1i or Motorola MOTORIZR Z8. Always confirm with the manufacturer's web site.

phone manufacturer
All lowercase, not Phone Manufacturer (handset manufacturer is also appropriate and can be used interchangeably)

Platforms
Only use when referring to Symbian OS combined with a user interface such as S60 or UIQ, unless there is an accompanying description of the platform which is meaningful to a specific target audience.
Examples:
Symbian OS is a platform for device middleware
S60 on Symbian OS is a platform for mass market smartphone development
not
Symbian platform
UIQ platform

S60 3rd Edition
Not Series 60. No superscript in 3rd. Capitalize 'Edition'.

Symbian OS
Never use 'the Symbian OS'. Symbian does not have a possessive, so never use Symbian OS's, use for Symbian OS Must never be abbreviated to SOS.

UIQ
Does not precede with an article. If referring to the entire software platform, follow with platform; otherwise follow with some other appropriate word (as in UIQ smartphone)

UIQ 3
Not UIQ v3 or UIQ 3.0

Numbers


Write 0 to 9 as words except when adjacent to each other, for example, 7- to 14-year olds.

Numbers larger than 10 should be written as numerals except at the start of sentences when they should be spelt out. Example: There were 34 delegates at the conference. Twenty seven of them were late.

Use the same rules when referring to a position (example: One third of the audience had a valid excuse for their tardiness) except when a numeral is standard. Example: S60 3rd Edition or proceed down 3rd Avenue for six blocks.

Avoid very large numbers at the start of sentences - they look clumsy when spelt out. Example: Three thousand, four hundred and twenty two milliners descended on Paris.

Numbers of four digits or more should not have commas in, as these are used as decimal points in some places. Instead insert a space to separate the groups of digits in numbers of 5 or more places. Example: 1000 not 1,000 and 50 000, not 50,000.

Do not use percent, use % instead. However, use percentage, not %age.

Passive Voice


Prefer to use the active voice. Never use the passive voice if you can use the active voice instead. owl.english.purdue.edu/handouts/grammar/g_actpass.html contains tips. An example would be 'the book was written by the author' being replaced by the 'the author wrote the book', or 'Symbian developed Symbian OS', not 'Symbian OS was developed by Symbian.'

Past and Present Tense

See Tenses.

Proper Nouns

See Names and Proper Nouns.

Punctuation


Do not use the 'Oxford' or serial comma (a comma before the 'and' that prefixes the last item on a list), unless it makes your writing clearer.
Examples:
One, two and three
not One, two, and three

but boat race, apples and pears, and china plate
not Boat race, apples and pears and china plate.

Ellipses should be exactly three full stops (...) with a space between the preceding word and the start of the ellipsis.

Use 'single quotes' at all times. Example: The idiom is known as 'two-phase construction' and used commonly on Symbian OS.

The only exception occurs where you have a quote within a quote, in which case the inner quote should use double quotes. Example: David said, 'So then he said, "The Aristocrats" and we all fell about laughing.'

Punctuation dividing a sentence of reported speech is put inside the quotation marks. Example: He said, 'I like it'. But: 'I like it,' he said, 'and so will you!'

Block quotes are to be put in a separate paragraph, with no surrounding quotation marks, and are not to be set in italics. The quote should be indented from the rest of the text. The title of the source publication should be set in italics and ranged to the right, underneath the quote. Make no changes to the material reproduced in a block quote.

Expressions in parentheses (round brackets) are punctuated as though they were separate from the surrounding text, except for the initial capital letter and ending period are omitted (question marks and exclamation marks remain).
The surrounding sentence is punctuated as normal, as if the parenthetical expression were not there.
Parenthetical expressions that are wholly detached from the rest of the text are treated as complete sentences and the final period goes inside the parenthesis.
Examples:
I didn't want to have any parentheses (I think they are a bore), but I couldn't avoid it.
This sentence is ever so neat (and don't you agree?), even if I say so myself.
(Separate parentheses for separate sentences.)

Quotes

See Punctuation.

References and Citations


All works cited in the text must have an entry in the references section. When citing, the author's name and the date of publication must be used. If the author is an indirect object of the sentence then the author name and date must be included in brackets. Example: It has been argued (Harrison and Shackman, 2007) that...

If the author is a direct object of the sentence then only the date needs to be in the brackets. Example: Stichbury (2007) argues that....

If there is more than one work cited by the same author with the same year of publication then they must be referenced 'a', 'b', and so on, after the authors name. Example: (Heath, 2007a) and (Heath, 2007b)).

The works must appear in the references with the identifying letters as well.

Books with one author
Author. (Date) Title, Publisher, Location of Publisher.
Example:
Martin, R.D. (1990) Primate Origins and Evolution, John Wiley & Sons, Ltd, Chichester

Edited or multi-authored books
Authors. (Date) Title, Publisher, Location of Publisher.
Example:
Dhir, R.K. and Green, J.W. (eds) (1990) Protection of Concrete, John Wiley & Sons, Ltd, Chichester.

Chapters in edited or multi-authored books
Authors. (Date) Chapter title in Title, Publisher, Location of Publisher, Pages.
Example:
Stewart, S. and Kam, K.C. (1990) Radiotherapy techniques, planning and equipment, in Treatment of Cancer, 2nd edn (eds K. Sikora and K.E. Halnan), John Wiley & Sons, Ltd, Chichester, pp. 827--51.

Journal Articles
Author(s). (Date) Article Title. Journal Title, Volume number (Issue number), Pages.
Example:
Onodera, A., Inoue, K., Yoshihara, H. et al. (1990) Synthesis of cubic boron nitride from rhombohedral under high static pressure. Journal of Materials Science, 25 (10), 429--84.

Conference Proceedings
Author(s). (Date) Title, Proceedings of Conference Name, Date of Conference, Location of Conference. Publisher, Location of Publisher.
Example:
Reinhardt, H.W. and Naaman, A.E. (eds) (1992) High Performance Fiber Reinforced Cement Composites. Proceedings of the International RILEM/ACI Workshop, June 23--26, 1991, Mainz,Germany. John Wiley & Sons, Ltd, Chichester.

Technical Reports
Organization (Date) Report Authors. Report Number. Title
Example:
World Health Organization (1982) WHO Expert Committee on Specifications for Pharmaceutical Preparations. 28th report. WHO Tech. Rep. Ser. 681.

Web sites
Author(s) (Date) Title, URL, (date accessed).
Example:
Organization for the Advancement of Structured Information Standards (1999) XML Exchange Table Model Document Type Definition, http://www.oasis-open.org/specs/tm9901.html (accessed 17 July 2007).

If material has not been printed yet '(in press)' should be inserted before the final period.

Referring to Our Users


Use 'end user' not 'end-user'. The MS Manual of Style reads as follows:
'end user, end-user. Avoid; use user, customer, or you instead. It is acceptable to use end user in content for software developers to distinguish the developer from the user of the developer's program.'

Speech

See Punctuation.

Tables

See Diagrams and Tables.

Technical Terms (Standard)


This separate page contains a set of standard technical terms that commonly cause confusion when written in text. For consistency, the terms should be used as quoted. If a term is not shown on this list, please check the Symbian-Specific set or the Symbian Glossary.

Technical Terms (Symbian-specific)


This separate page contains a set of Symbian-specific technical terms that commonly cause confusion when written in text. For consistency, the terms should be used as quoted. If a term is not shown on this list, please check the standard set or the Symbian Glossary.

Telephone Numbers


Use a standard format: +44 20 7154 1000

Templates


If you are writing a book, after the manuscript has been finalized, the text will be laid out by a professional designer so it is not necessary for you to use/design a specific template. However, a template is available and it is helpful if you use the styles contained within it - especially to demarcate code.

If you are writing a paper then you must use the MS Word template provided

Please only submit text saved in MS Word .DOC format.

Tenses


Use the simple present tense when writing. Example: When you press Enter, the program updates the file not When you press Enter, the program will update the file.

In descriptive passages, use the simple past tense. Example: Symbian was established as a private independent company in June 1998.

When referring to events that will happen in the future, use the simple future tense. Example: The next time you start the Symbian OS, the new icons will be displayed on the UI.

Times

See Dates and Times.

Trademarks


Do not use the ™ and ® symbols in text. Capitalize trademarks as proper nouns, unless the company uses it differently; in that case, follow their punctuation. Examples: iPhone or eBay)

Keep a note of any trademarks or registered names you use in the text.

If you are writing a book inform Symbian Press of these as soon as possible so we can ensure that Wiley have any necessary legal text inserted at the beginning of the book.

If you are writing a paper, acknowledge them at the end.

URLs


Avoid highly specific URLs as these quickly become outdated and are difficult to maintain - prefer to keep a wiki page on developer.symbian.com/wiki instead to store and update relevant links.

Quote URLs in bold italics (or, if just italics are used, be consistent throughout the book, paper or booklet)

Omit http:// from all URLs.

In any online media, make all quoted URLs hyperlinks.

User Input


Right-click, left-click and double-click are all hyphenated whenever they occur.

When you are telling a user to use a menu command, the commands should be capitalized and separated by a comma. Example: File, Save.

When referring to on-screen message and dialog boxes, you should use the exact spelling and capitalization as the program you are referring to.

Key names should be referred to with all uppercase letters (example: CTRL, ALT, and DEL) and commands should be separated by a plus sign to indicate the keys are pressed simultaneously. Example: CTRL+S or SHIFT+P.

Users

See Referring to Our Users.

Interactive Services Terms & Conditions of use | Terms of use | Privacy policy | Media Center | Contact us | © 2008 Symbian