Style Guide

  1. Table of Contents

1      Table of Contents………………………………. 2

2      Forms………………………………………………. 3

2.1      General……………………………………… 3

3      System Text………………………………………. 3

3.1      Input Field Labels……………………….. 3

3.2      Regular Text………………………………. 3

3.3      Header Text……………………………….. 3

3.4      Column Headers…………………………. 3

3.5      Note Text…………………………………… 3

3.6      Control and Radio Button Text………. 3

3.7      Subheadings and Array Labels………. 4

4      Client Art Icons…………………………………. 5

4.1      General……………………………………… 5

4.2      Label Text Below the Icons…………… 5

4.3      Code Note………………………………….. 5

5      Client Non-Art Buttons……………………….. 6

5.1      General……………………………………… 6

5.2      Label Text on the Button………………. 6

5.3      Spacing……………………………………… 6

6      List Boxes and Input Fields………………….. 7

6.1      General……………………………………… 7

6.2      Tabbed List Box…………………………. 7

7      Tabs………………………………………………… 8

7.1      Front Tabs…………………………………. 8

7.2      Back Tabs………………………………….. 8

8      Sample Forms……………………………………. 9

8.1      Simple tabs for mailbox form………… 9

8.2      Edit Buddy List Group…………………. 9

8.3      Toolbar Preferences…………………… 10

8.4      Automatic AOL Walk-Through: Congratulations           10

9      Usage…………………………………………….. 11

9.1      Buddy List (TM) feature…………….. 11

9.2      Instant Message (TM) feature………. 11

9.3      Buttons, Icons, Check boxes, and Menu commands………………………………………….. 11

9.4      Keywords………………………………… 12

9.5      Lists: Numbers vs. Bullets…………… 12

9.6      Master Account and Sub-accounts… 13

9.7      Modem Speeds…………………………. 13

9.8      NOTE: and Warning! Messages…… 13

9.9      Numbers………………………………….. 13

9.10    Time……………………………………….. 14

9.11    Trademarks………………………………. 14

9.12    Other Guidelines for Writing Help Procedures           15

10       Punctuation………………………………….. 16

10.1    Commas………………………………….. 16

10.2    Dashes…………………………………….. 16

10.3    Period……………………………………… 16

10.4    Quotation Marks……………………….. 16

11       Branding Terminology…………………… 17

12       Code Centric Terms………………………. 19

  • Forms
  • Gutter: Live area of screen should begin at least 5 pixels from edge of form; it is usually between 8 and 10 pixels from the edge.
  • Background Color: 253,255,247
  • System Text
  • Font: Arial 9pt. Bold
  • Color: 0,0,0  (black)
  • Editorial Style: Title Case (all important words have initial caps), use colon
  • Example: See Sample Form 8.2, Edit Buddy List Group. Field labels are Buddy List Group Name:, Type a Screen Name:, and Change Buddy List Group Name to:      
  • Regular Text
  • Font: Arial 8pt. Normal
  • Color: 0,0,0 (black)
  • Editorial Style: Sentence Case (first word capitalized), use appropriate punctuation; use Bold to call out button labels or menu options, where referring to a button resident on the form, or an icon on the toolbar, or an option on a toolbar drop-down menu
  • Example: See Sample Form 8.4, Automatic AOL Walk-Through: Congratulations. Regular text is fourth paragraph.
  • Header Text
  • Font: Arial 14pt Bold
  • Color: 0,0,0  (black)
  • Editorial Style: Title Case (all important words have initial caps)
  • Example: See Sample Form 8.4, Automatic AOL Walk-Through: Congratulations.
  • Column Headers
  • Font: Arial 9pt. Bold
  • Color: 0,0,0  (black)
  • Editorial Style: Title Case (all important words have initial caps)
  • Example: See Sample Form 8.2, Edit Buddy List Group. Column Header is Buddies in Group     
  • Font: Arial 8pt. Normal
  • Color: 0,0,0 (black)
  • Editorial Style: NOTE in all-caps, followed by colon, Sentence Case (first word following colon capitalized), use appropriate punctuation; use Bold to call out button labels or menu options, where referring to a button resident on the form, or an icon on the toolbar, or an option on a toolbar drop-down menu
  • Example: See Sample Form 8.4, Automatic AOL Walk-Through: Congratulations. Note text is third paragraph.
  • Control and Radio Button Text
  • Font: Arial 9pt Bold
  • Color: 0,0,0  (black)
  • Editorial Style: Sentence Case (first word Capitalized), no trailing punctuation
  • Example: Sample Form 8.3, Toolbar Preferences.
  • Subheadings and Array Labels
  • Font: Arial 9pt Bold
  • Color: 0,0,0  (black)
  • Editorial Style: Title Case (all important words have initial caps), use colon
  • Example: Sample Form 8.3, Toolbar Preferences. Array labels are Appearance: and Location:; subheadings are Navigation: and History Trail:


  • Client Art Icons
  • Trigger Style: 9 (Triple-State)
  • Height: 38 pixels (except for special cases)
  • Width: 38 pixels (except for special cases)
  • Label Text Below the Icons
  • Color: 0,0,0 (Black)
  • Font: Arial
  • Size: 8 pt
  • Style: Normal
  • In order to enable keyboard navigation, the following atom must be added to the instream of all triple-state buttons:
  • atom$mat_bool_draw_focus <yes>
  •  


  • Client Non-Art Buttons
  • Trigger Style: Style 1
  • Color, Face: 152,20,0
  • Color, Top Edge: 221,181,178
  • Color, Bottom Edge: 118,25,11   1 pixel line
  • Height: 23 pixels (If the system button is precisely defined; otherwise, determined by the font size of the label)
  • Length: Define by label width (Padding=7). Make wider as necessary for longer button labels.
  • Spacing
  • Spacing: Ten pixels between buttons where possible, and where it doesn’t conflict with natural grouping.
  • Tabbed List Box
  • Color: AOL: 152,20,0
  • Gutter: Six pixel border on all sides; 23 pixel border above and below, if text field is needed.
  • Frame Highlight: 221,181,178
  • Frame Shadow: 0,0,0


  • Tabs
  • Font: Arial
  • Font Color: 255, 255, 255
  • Font Style: Bold, Initial Caps
  • Font Size: 8 pt
  • Face Color: 152,20,0
  • Highlight: 221,181,178
  • Shadow: 118,25,11
  • Height: usually 23 pixels, but in fact determined by the font size of the label
  • Width: determined by the font size of the label

Sample Form 8.1, Simple tabs for mailbox form.

  • Back Tabs
  • Font: Arial
  • Font Color: 255, 255, 255
  • Font Style: Normal, Initial Caps
  • Font Size: 8 pt
  • Face Color: 153,153,0
  • Highlight Color: 221,221,178
  • Shadow Color: 123,130,24
  • Height: usually 22 pixels, but in fact determined by the font size of the label
  • Width: determined by the font size of the label
  • Sample Form 8.1, Simple tabs for mailbox form.


  • Usage
  • To protect the Buddy List (TM) (Lista de Amigos) feature trademark, follow these guidelines:
  • Always use the term as an adjective. NO part of Buddy List (Contact or List) can be used as a noun.

Buddy List service         (Servicio de Lista de Amigos)

Buddy List feature         (Función de Lista de Amigos)

Buddy List groups         (Grupos de Lista de Amigos)

Buddy List preferences (Preferencias en Lista de Amigos)

Buddy List window         (Ventana de Lista de Amigos)

  • Always use the singular.

Correct:            Buddy List service (Servicio de Lista de Amigos)

Incorrect:          Buddy Lists (Listas de Amigos)

  • The first instance on a page or form should use a TM symbol. NOTE: When a superscript TM is not available, use (TM) in parentheses.

The Buddy List (TM) feature lets you create Buddy List groups.

To protect the Instant Message (TM) (Mensajero Instantáneo) and Instant Messenger (TM) feature trademarks, follow these guidelines:

  • Always use the term as an adjective. NO part of Instant Message or Instant Messenger can be used as a noun.

            Instant Messenger service             (Servicio de Mensajero Instantáneo)

Instant Message feature             (Función de Mensajero Instantáneo)

            Instant Message notes               (Notas de Mensajero Instantáneo)

              Instant Message window                 (Ventana de Mensajero Instantáneo)

  • Always use the singular

            Correct:            Instant Messenger service (Servicio de Mensajero Instantáneo)

            Incorrect:          Instant Messages (Mensajes Instantáneos)

  • The first instance on a page or form should use a TM symbol. NOTE: When a superscript TM is not available, use (TM) in parentheses.

         The Instant Message (TM) feature lets you send notes to your friends.

box (caja)

button (botón)

check box (casilla de selección)

icon (ícono)

list (lista)

menu (menú)

radio button (botón de opción)

text box (caja de texto)

toolbar (barra de herramientas)

  • Button Example:

 Click Search. (Hacer click en Buscar)

 Click the Search button. (Hacer click en el botón Buscar.)

  • Icon Example:

Click the News icon for Today’s News. (Hacer click en el ícono Noticias para las Noticias del Día.)

  • Check box Example:

Click the E-mail check box to search only e-mail information. (Hacer click en la caja de selección de Correo Electrónico para buscar solamente información de correo electrónico)

  • Menu Example:

Click the File menu, and click Print on the drop-down menu. (hacer click en el menú de Archivos y después hacer click en Imprimir en el menú desplegable.)

  • Keywords
  • Always use the word “Keyword” followed by a colon and the word being referred in all caps. Capitalize the word “Keyword”. If the Keyword contains a space, do not run the words together.

            Keyword: PASSWORD (Clave AOL: CONTRASEÑA)

            For international access information, Keyword: INTERNATIONAL ACCESS. (Para información sobre acceso internacional, Clave AOL: ACCESO INTERNACIONAL)

  • Although hyperlinking a Keyword is useful, it can teach the member to rely on hyperlinks and steer them away from learning the Keyword feature. Keep in mind that new members are more likely to need hyperlinks than experienced members. Use your best judgment. When a hyperlink is placed on a Keyword, make only the referred Keyword a hyperlink.

            For access information, Keyword: ACCESS.

(Para información sobre acceso, Clave AOL: ACCESO)

  • Lists: Numbers vs. Bullets
  • When writing in a list format, begin the list with a short explanation title of what the following steps will accomplish. Bold this title, use sentence case (initial word is capitalized) and place a colon at the end. If the list includes a set of instructions, number each step using arabic numerals. Use a period and space after numbered items. Use asterisks to denote unordered items in a list. Use a period at the end of each step in both the numbered and bulleted lists. NOTE: When you cannot use Word-style bullets, use asterisks instead.
  • Example — Bulleted list:

There could be several reasons you received the No Carrier message:

  • Someone picked up another extension while you were connected.
  • You did not disable Call Waiting while you were connected to AOL and a call came in while you were connected.
  • You have selected the wrong modem profile in your AOL setup.

Hay varias razones por las cuales se recibe el mensaje de No Carrier: 

  • Alguien levantó otra extensión mientras se tenía una conexión con AOL.
  • No se desabilitó la función de Llamada en Espera y entró una llamada mientras se tenía una conexión con AOL.

*    Se seleccionó un perfil de modem equivocado en la configuración de AOL.

  • Example — Numbered list:

To save e-mail or a text document:

  1. Open the e-mail or text document.
  2. Click the File menu, and click Save on the drop-down menu. The save dialog box appears.
  3. Type a name for the file and select a folder.

4.   Click Save.

Para guardar un mensaje de correo o un documento de texto:

  1. Abrir el correo o documento
  2. Hacer click en el menú de Archivo y hacer click en Guardar en el menú desplegable.  Aparecerá la ventana de diálogo para guardar.
  3. Escriba el nombre del archivo y seleccione una carpeta.
  4. Hacer click en la opción Guardar
  • Master Account and Sub-accounts
  • Members have one account, which can have up to five Screen Names on it at any time. The first Screen Name, which cannot be revised, is the master account, and any other Screen Names are known as sub-accounts.

Parents can assign sub-accounts to their children for Parental Control purposes, but should be cautious about giving children the password to the master account.

  • Modem Speeds
  • Baud and bps are not the same. Baud is the measurement of speed at which data (bits) are transferred. At a higher baud, more bits are transferred. A 300 baud modem is likely to equal 300 bps, but a 9600 baud modem can transfer more than 9600 bps. Modems measured in baud are becoming obsolete. Use bps or Kbps.

            Correct:            With a 28.8 Kbps modem, the file will download in 2 minutes.

            Correcto:          Con un módem de 28.8 kbps, el download del archivo tomará 2

            minutos.

            Incorrect:          With a 28800 baud modem, the file will download in 2 minutes.

Incorrecto:         Con un módem de 28800 bauds, el download del archivo tomará dos minutos.

  • NOTE: and Warning! Messages
  • Text which is of vital importance to members may be set off with either a NOTE: or a Warning! prefix.
  • The word NOTE: is all caps, followed by a colon, and starts its own paragraph. If there are several parts, or distinct items to note, the word NOTE is not repeated.

NOTE: In order for AOL Scheduler sessions to run, you must check the Enable Scheduler check box.

  • The word Warning is title case (initial cap), followed by an exclamation point, and starts its own paragraph. The point of warning immediately follows the word Warning. Any explanatory text comes last.

Warning! The file you are about to download contains executable code. If you don’t know the person who sent you this file, exercise caution in downloading.

Precaución! El archivo que está a punto de bajar contiene código ejecutable. Si desconoce la persona que lo envió, tome sus precauciones al hacer el download.

  • Numbers
  • Use commas in numbers greater than 1,000:

            Correct:            He read a 2,333-page book.

            Correcto:          El leyó un libro de 2,333 páginas.

            Incorrect:          He read a 2333 page book.

            Incorrecto:        El leyó un libro de 2333 páginas

  • Use periods for decimals:
    For example: 12,300.00
  • Spell out numbers one through ten, and use figures for all numbers above ten. However, if you must use figures for one of the numbers, then, for consistency, use figures for all the numbers.

            Correct:            The men took eight lunches and ten toolboxes to work.

                                    The men took 8 lunches and 45 toolboxes to work.

Correcto:          Los hombres llevaron ocho almuerzos y diez cajas de herramientas al trabajo.

                        Los hombres llevaron 8 almuerzos y 10 cajas de herramientas al trabajo.

            Incorrect:          The men took eight lunches and 45 toolboxes to work.

Incorrecto:        Los hombres llevaron ocho almerzos y 45 cajas de

herramientas al trabajo.

Exceptions:

  • Use numerals when displaying a series of numbers:

            Correct:            He read pages 1-3 of the book.

            Correcto:          El leyó las páginas 1-3 del libro.

  • Use numerals when referring to a length of time:

            Correct:            You have 3 months to restore your Screen Name.

            Correcto:          Tiene usted 3 meses para reponer su nombre de pantalla

              Use format dd/mm/yyyy

              For example: September 5th, 1999 is 05/09/1999

              Use military format 00:00 to 24:00 h

              For example: 12:00 means noon and 23:00 is 11:00 P.M.

To protect the trademarks for several common AOL features, follow this guideline:

  • Always use the term as an adjective. Do NOT use it as a noun. NOTE: Assume AOL uses the same style to protect AOL features.
  • AOL features that apply to trademark guidelines:

America Online service (Servicio America Online)

AOL service (Servicio AOL)

Buddy List feature (Función de Lista de Amigos)

AOL service (Servicio AOL)

Instant Message feature (Función de Mensaje Instantáneo)

Instant Messenger feature (Función de Mensajero Instantáneo)

Parental Controls feature (Función de Bloqueo / Restricción para Menores / Control de Menores)

My Place service (Servicio Mi Espacio en la Red)

PrimeHost service (Servicio PrimeHost)

In order to make AOL client applications even more user friendly, it is recommended to use the informal terminology rather than the formal.

                     Correcto:            Invita a un amigo a utilizar el nuevo servicio de AOL.

                     Incorrecto:          Invite usted a un amigo a utilizar el nuevo servicio de AOL.

                     Correcto:            Haz click en Invita a un amigo.

                     Incorrecto:          Haga click en Invita a un amigo.

  • Other Guidelines for Writing Help Procedures
  • If there are several ways to accomplish a task, pick the best one and explain it. Do not give options that make members decide which method to use.
  • Use terms that members understand (like “start” (iniciar) and “cancel” (cancelar)). Never use slang or computer jargon (like “launch” (lanzar) and “abort” (abandonar)).
  • Use precise words that best describe the procedure.
  • Use active voice: “The file you downloaded” vs. “The file that was downloaded” and “You did not install the file” vs. “The file was not installed.” Besides being more direct, it’s also more personal.
  • Use complete sentences.
  • Use present tense. Save future tense for those occasions when eventual  (rather than immediate) results are truly indicated.

Correct:            Click the Create icon on the toolbar. A blank e-mail form appears

Correcto:          Hacer click en el ícono Crear de la barra de herramientas.  Una forma en blanco para correo aparece.

Correct:            When your Filing Cabinet gets full, you will want to delete old files.

Correcto:          Cuando su Archivero se llene, usted querrá borrar o eliminar algunos archivos anteriores.

Incorrect:          Click the Create icon on the toolbar. A blank e-mail form will appear.

Incorrecto:        Hacer click en el ícono Crear de la barra de herramientas.  Una forma en blanco para correo aparecerá.

  • Use gender-neutral terminology when possible, but when that is not possible, use correct, inclusive pronoun references.

Correct:            Click Send to send your friend the message. A similar window pops up on his or her monitor with your message in it. Your friend has the option to respond or to cancel your message.

Correcto:          Hacer click en Send para enviarle a su amigo(a) un mensaje.  Una ventana parecida aparece en el monitor de su amigo(a) con su mensaje en el mismo.  Su amigo(a) tiene la opción de contestar o cancelar el mensaje.

Incorrect:          Click Send to send your friend the message. A similar window pops up on their monitor with your message in it. They have the option to respond or to cancel your message.

Incorrecto:        Hacer click en Send para enviarle a su amigo un mensaje.  Un ventana parecida aparece en el monitor de su amigo con su mensaje en el mismo.  Su amigo tiene la opción de contestar o cancelar el mensaje.

  1. Punctuation
  1. Commas
  2. Use a comma to set off a phrase that is not critical to the meaning of the sentence:

  Correct:            The programming plan, which was too long, was turned in yesterday.

  Incorrect:          The programming plan which was too long was turned in yesterday.

  Correcto:          El plan de programación, que era demasiado largo, se entregó ayer.

  Incorrecto:        El plan de programación que era demasiado largo se entregó ayer.

  1. Dashes
  2. A dash is denoted by two hyphens. Use a space before and after the dash.

              Correct:            Dashes — useful yet often overlooked — shouldn’t be ignored.

            Incorrect:          Dashes–useful yet often overlooked–shouldn’t be ignored.

              Correcto:          Guiones — comunmente pasados por alto pero útiles — no se deben ignorar.

              Incorrecto:        Guiones–comunmente pasados por alto pero útiles–no se deben ignorar.

  1. Period
  2. Space once after a period (and all other punctuation).
  • Place periods at the end of long list items in help text. This does not apply to lists on client forms.
  • Use periods in numbers greater than 1,000:

*use a coma in numbers greater than 1,000.

  Correct:           He read a 2,333-page book.

   Incorrect:           He read a 2333-page book.

                           Correcto:           Leyó un libro de 2,333 páginas.

                           Incorrecto:         Leyó un libro de 2333 páginas.

  1. Quotation Marks
  2. Do not place button, menu, icon, and check box names in quotations. See Buttons, Icons, Check boxes, and Menu commands above for the correct usage.
  • When providing sample search terms in an example, do not enclose the search terms in quotations unless the member is meant to type the quotation marks. Put the search terms in bold instead.

Correct:            To find documents about cats and dogs, type cats and dogs. Typing “cats and dogs” will tell NetFind to search for that exact phrase.

Correcto:          Para encontrar documentos sobre perros y gatos, escribe perros y gatos. Al escribir “perros y gatos” se buscaría la frase exactamente como se escribió.

  1. Branding Terminology

America Online

America Online México / AOL México

Mail Center

E-mail

My Files 

Mis Archivos

Favorite Places

Favoritos(for the button) / Lugares Favoritos(for first item on menu)

Sign On

Entrar / Iniciar sesión / Conectar

Entrar: this would be the most common term to use.

Iniciar sesión: this would be more accurate than the first, but longer.

Conectar: would be OUR choice, since it’s very accurate, short and to the point.

Sign Off

Salir / Terminar sesión / Desconectar

            Same as previous entry.

Address Book

Directorio

Preferences

Preferencias

Automatic AOL

Auto AOL

The exact translation would be AOL Automático. We tried here to give a shorter option because it is in the toolbar, and yet it has the same meaning.

Personal Filing Cabinet (PFC)

Folders / Carpetas / Organizador de Archivos

Organizador de Archivos: OUR pick because even though it is not the exact translation it does reflect the use of the feature.

Folders and Carpetas: They mean the same, Folders is used in Mexico by a lot of people.

Screen Name

Usuario

Parental Controls

Bloqueo / Restricción para Menores / Control de Menores

The three terms give you the same idea, it’s just a matter of words: block, restrict, or control.

Buddy List

Lista de Amigos (Amigos En Línea will appear when the Buddy List window is open)

Personal Publisher

ConstruWeb / Editor Personal (exact translation not available)

ConstruWeb: suggests or invites the users to create, build their page.

Editor Personal: has a more technical approach, but we like it.

Instant Messages

Mensajes Express / Instantáneos / En línea

It depends on the name given to the AIM service for Latin America.

Keyword

Clave AOL

Clave is the most commonly used and understood term for keyword, adding AOL gives it a more specific sense regarding it’s use.

Member Directory

Directorio de Usuarios

Channel

Canal

Mail

Correo

My AOL

Mi AOL

 

Download Manager

Asistente / Administrador de Downloads

Downloads is commonly used by Latin American sites. Administrador would be more accurate and Asistente would be more ‘familiar’ to people.

AOL Live

AOL en Vivo

Message Boards

Tablero / Corcho de Mensajes

Tablero de Mensajes: it would be the literal translation and works fine.

Corcho de Mensajes: usually bulletin boards are made with cork and they’re easily identified. Sounds more fun. 

Member Services

Servicio a Usuarios

Password 

Contraseña

 

People Connection

Comunidad / Punto de Encuentro

Punto de Encuentro: would be the place where you can meet and chat with people all around the world.

Comunidad: gives a sense of what the chats are about: people with common interests get together to discuss them, regardless of age and gender.

Member Profile

Perfil del Usuario

Online

En línea

Chat

Chat

The best translation would be no translation.

Instant Messenger

Mensajero Instantáneo

  1. Code Centric Terms
  2.  

Saved Mail

Correo Guardado

Incoming Mail

Recibiendo correo / Correo entrante (depende del modo)

Recibiendo correo: would be the choice if it appears in a message box or something dynamic (present continuous).

Correo entrante: would be correct for a menu option or toolbar.

Download

Download

As mentioned before, this is a term of common use in Latin America, easier to understand than its rarely used translation.

Mail Waiting To Be Sent

Correo por enviar

Mail You’ve Sent

Correo enviado

Newsgroups

Foros

We liked the word Foros because it captures the meaning of the service or feature very well.

Incoming/Saved Postings

Notas recibidas/guardadas

Postings Waiting to be Sent

Notas por enviar

Postings You’ve Sent

Notas enviadas

Offline mail

Correo fuera de línea

 

Guest

Invitado

New User

Nuevo Usuario

Existing Member

Usuario existente

Install

Instalar

 

Uninstall

Desinstalar

Installation

Instalación

 

Access Number

Número de Acceso

Download Manager

Download

Read Mail

Leer Correo

Setup

Configurar

 

Find

Buscar

Buddy

Amigo

Go

Ir

This would be the exact translation and works fine.

Comments

No comments yet. Why don’t you start the discussion?

Leave a Reply