Guía de estilo

General

Case

Todo el texto debe escribirse en minúsculas con mayúscula inicial. Esto incluye todos los párrafos, encabezados y títulos de página.

GitBook renders some text in ALL CAPS, such as group (aka chapter) titles in the **table of contents** on the left of the screen. However, you should use sentence case when editing this text.

Los nombres propios y abreviaturas deben capitalizarse de acuerdo con la forma predominante utilizada en la página de Wikipedia del tema en cuestión.

Import the MusicXML file. ✅ MusicXML __is capitalized

Customize the user interface (UI). ✅ UI __is capitalized and __user interface __is not

Available in braille and Modified Stave Notation. ✅ MSN __is capitalized and __braille __is not

Las contracciones del habla cotidiana no deben capitalizarse.

A quarter note (aka crotchet) is a musical duration. ✅ aka __is not capitalized

UI labels

Al escribir instrucciones para el usuario, el texto que aparece en la interfaz de usuario de MuseScore debe copiarse textualmente, incluida cualquier capitalización, y se destaca en negrita sin encerrar comillas.

Press the Not now button. ✅ Not now __is bold and capitalized like in the application

Arrows in UI paths

Type -> to describe the path through submenus or through the hierarchy of a dialog. GitBook will format this as a single arrow character, though in editing mode it appears as separate characters. Since the text either side will be styled in bold (as all text from the UI should be), keep the arrows bold too.

Choose File -> Save other -> Save a copy... ✅

Uncheck Style -> Notes -> Shorten stems. ✅

Bullet points

Bullet points (aka unordered lists) are used for listed content that is not an ordered process.

If the contents of a group of bullet points are not complete sentences, there's no need to use periods.

• Dynamics

• Accidentals

• Articulations ✅ No periods

When bullet points are complete sentences, use periods at the end of each sentence, even if there is only one.

• This is a one-sentence bullet point, with a period at the end.

• This is a bullet with two sentences. Periods are included after every sentence. ✅ Full sentences require periods

It's a common pattern to have some bolded text at the beginning of a bullet followed by a colon. In this case, the colon should be bolded too and the first character after the colon should be capitalized.

• Bullet: This is a good example. ✅ The colon is bold and 'This' is capitalized

• Bullet: this is a bad example. ❌ The colon is not bold and 'this' is not capitalized

Numbered lists

Numbered lists (aka ordered lists) are used for listed content that must be done in sequence. For explanations of how to execute a task, try to keep it to one sentence per number, and use periods at the end of each one.

1. Think of what to say.

2. Express each step a short sentence with a period at the end.

3. Finish the list. ✅

Hyperlinks

Cuando sea adecuado, se pueden añadir hipervínculos a palabras o frases clave en el texto ordinario, palabras o frases que deberían escribirse para que se mantenga el sentido sin el enlace. En general, la URL completa no debe mostrarse.

Watch the tutorial video. ✅ Text makes sense without the link

Vea el tutorial aquí. ❌ El texto no tendría sentido si se eliminara el enlace

Véalo en https://www.youtube.com/watch?v=z4Ecaaqwg8U. ❌ No muestre la URL

Plain domain names should be captalized like the brand name. The top-level domain (TLD, e.g. .com, .org, .co.uk, etc.) should be omitted unless there's a good reason to include it.

Find us on Facebook and YouTube. ✅ Omit .com TLDs for these popular sites

Listen on Audio.com. ✅ TLD is part of the website's branding

Visit MuseScore.org. ✅ TLD is necessary to distinguish from MuseScore.com

Download the installer from MuseHub.com. ✅ Referring specifically to the website

Get the sounds in MuseHub. ✅ Referring to the app (but linking to the website)

Keyboard shortcuts

Los atajos de teclado deben formatearse de la siguiente manera:

Press Shift+1—9. ✅ en-dash __indicates range

Press Ctrl+Shift++/- (Mac: Cmd+Shift++/-). ✅ slash __indicates alternatives

Los modificadores deben escribirse de esta manera y en este orden para cada plataforma:

Windows/Linux: Win+Ctrl+Alt+Shift+Fn+... ✅

Mac: Ctrl+Cmd+Option+Shift+Fn +... ✅

In Linux-specific instructions, the Win key should be written as Super.

Las teclas que escriban caracteres imprimibles deben estar representadas por ese carácter.

. , ; ' [ ] / \ - = ` etc. ✅

All non-printing keys should be referenced by their (possibly abbreviated) name rather than by a symbol. This includes the cursor keys.

Space Backspace Del Ins Esc Return Up Down Left Right PgUp PgDn Home End Menu Caps Lock ✅

Typed characters

Typed sequences should usually be formatted as inline code, even if it's just a single character.

To enter a double flat, type bb. ✅ Inline code __(single element)

Occasionally, it may be preferable to show the actual keys pressed, formatted as keyboard shortcuts rather than as inline code.

To enter a double flat, type B B. ✅ Keyboard keys __(space between each key)

Structure

Pages

Actualmente está viendo la página de la[ Guía de estilo](style-guide.md), que es una subpágina de [Acerca del manual](./).

Page titles

Los títulos de página deben ser relativamente cortos. Idealmente, el título debe caber en una línea en el resumen a la izquierda de la pantalla, aunque esto no siempre es posible. Tenga en cuenta que los títulos de página pueden ser significativamente más largos cuando se traducen a otros idiomas además del inglés.

Consejos para mantener breves títulos de página:

• Evite decir "partitura" (por ejemplo, "seleccionar elementos", no "seleccionar elementos en la partitura")

• Evite decir "MuseScore" (por ejemplo, "Actualización", no "Actualización de MuseScore Studio")

Subpages

Cuando se usan las subpáginas, solo se puede utilizar un nivel de subpáginas. Nunca cree una sub-subpágina.

Las páginas padre deberían tener títulos muy cortos porque su título aparece en las URL de todas sus subpáginas.

En general, preferimos usar grupos en lugar de subpases, para evitar anidamientos en el resumen.

Groups

Groups are like chapters. They are displayed in ALL CAPS in the table of contents on the left of the screen (e.g. 'INTRODUCTION' and 'NAVIGATION'). The current group name is also shown, hyperlinked, above each page title in the main content area.

Group names should be written in sentence case – the ALL CAPS styling is handled by GitBook automatically.

Los grupos deberían tener nombres muy cortos. Esto se debe a que el nombre del grupo aparece en las URLs de todas las páginas dentro del grupo.

Es posible editar el slug del grupo para que sea más corto que el nombre real del grupo. Sin embargo, en general, esto no debe hacerse. En cambio, el nombre del grupo debe hacerse lo más corto posible.