# Guia de estilo

## General

### Case

Todo o texto deve ser escrito em **caixa baixa**. Isso inclui todos os parágrafos, títulos e títulos de página.

{% hint style="info" %}
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.
{% endhint %}

Nomes próprios e abreviações devem ser escritos com letra maiúscula de acordo com a forma predominante usada na página da Wikipédia sobre o tópico em questão.

> Import the MusicXML file. :white\_check\_mark: ***MusicXML*** \_\_*is capitalized*
>
> Customize the user interface (UI). :white\_check\_mark: ***UI*** \_\_*is capitalized and* \_\_***user interface*** \_\_*is not*
>
> Available in braille and Modified Stave Notation. :white\_check\_mark: ***MSN*** \_\_*is capitalized and* \_\_***braille*** \_\_*is not*

Contrações da linguagem cotidiana não devem ser escritas com caixa alta.

> A quarter note (aka crotchet) is a musical duration. :white\_check\_mark: ***aka*** \_\_*is not capitalized*

### UI labels

Ao escrever instruções para o usuário, o texto que aparece na interface do usuário do MuseScore deve ser copiado na íntegra, incluindo qualquer caixa alta, e destacado em negrito, sem colocar aspas.

> Press the **Not now** button. :white\_check\_mark: ***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 `->` as a single arrow character, though in editing mode it appears as separate characters. Since the text on either side will be styled in bold (as all text from the UI should be), keep the arrows bold too. Use a space on either side of each arrow.

> Choose **File -> Save other -> Save a copy...** :white\_check\_mark:
>
> Uncheck **Style -> Notes -> Shorten stems**. :white\_check\_mark:

### 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 :white\_check\_mark: *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. :white\_check\_mark: *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. :white\_check\_mark: *The colon is bold and 'This' is capitalized*
> * **Bullet**: this is a bad example. :x: *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. :white\_check\_mark:

### Hyperlinks

Quando apropriado, hiperlinks podem ser adicionados a palavras-chave ou frases em texto simples, que devem ser escritos de forma a fazer sentido sem o link. Em geral, o URL completo não deve ser exibido.

> Watch the [tutorial video](https://www.youtube.com/watch?v=z4Ecaaqwg8U). :white\_check\_mark: *Text makes sense without the link*
>
> Veja o tutorial [aqui](https://www.youtube.com/watch?v=z4Ecaaqwg8U). :x: *O texto não faria sentido se o link fosse removido*
>
> Veja em <https://www.youtube.com/watch?v=z4Ecaaqwg8U>. :x: *Não mostrar a 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](https://www.facebook.com/musescore) and [YouTube](https://www.youtube.com/musescore). :white\_check\_mark: *Omit .com TLDs for these popular sites*
>
> Listen on [Audio.com](https://audio.com/). :white\_check\_mark: *TLD is part of the website's branding*
>
> Visit [MuseScore.org](https://musescore.org/en). :white\_check\_mark: *TLD is necessary to distinguish from MuseScore.com*
>
> Download the installer from [MuseHub.com](https://www.musehub.com/). :white\_check\_mark: *Referring specifically to the website*
>
> Get the sounds in [MuseHub](https://www.musehub.com/). :white\_check\_mark: *Referring to the app (but linking to the website)*

### Keyboard shortcuts

Os atalhos de teclado devem ser formatados da seguinte maneira:

> Press `Shift`+`1`—`9`. :white\_check\_mark: ***en-dash*** \_\_*indicates range*
>
> Press `Ctrl`+`Shift`+`+`/`-` (Mac: `Cmd`+`Shift`+`+`/`-`). :white\_check\_mark: ***slash*** \_\_*indicates alternatives*

Os modificadores devem ser escritos nesta forma e nesta ordem para cada plataforma:

> Windows/Linux: `Win`+`Ctrl`+`Alt`+`Shift`+`Fn`+`...` :white\_check\_mark:
>
> Mac: `Ctrl`+`Cmd`+`Option`+`Shift`+`Fn` +`...` :white\_check\_mark:

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

Teclas que digitam caracteres imprimíveis devem ser representadas por esse caractere.

> `.` `,` `;` `'` `[` `]` `/` `\` `-` `=` `` ` `` etc. :white\_check\_mark:

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` :white\_check\_mark:

### 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`. :white\_check\_mark: ***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`. :white\_check\_mark: ***Keyboard keys*** \_\_*(space between each key)*

## Structure

### Pages

{% hint style="info" %}
Você está atualmente vendo a página \[Guia de estilo]\(style-guide.md), que é uma subpágina de \[Sobre o manual]\(./).
{% endhint %}

#### Page titles

Os títulos das páginas devem ser relativamente curtos. O ideal é que o título ocupe uma linha no Resumo à esquerda da tela, embora isso nem sempre seja possível. Lembre-se de que os títulos das páginas podem ser significativamente maiores quando traduzidos para outros idiomas além do inglês.

Dicas para manter títulos de páginas curtos:

* Evite dizer "partitura" (e.g. "Selecionando elementos", não "Selecionando elementos na partitura")
* Evite dizer "MuseScore" (e.g. "Atualizando", não "Atualizando o MuseScore Studio")

#### Subpages

Ao usar subpáginas, apenas um nível de subpágina pode ser usado. Nunca crie uma sub-subpágina.

As páginas principais devem ter títulos bem curtos porque o título aparece nas URLs de todas as suas subpáginas.

Em geral, preferimos usar [grupos](#groups) em vez de subpáginas, para evitar aninhamento no Resumo.

### Groups

{% hint style="info" %}
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.
{% endhint %}

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

Os grupos devem ter nomes bem curtos. Isso ocorre porque o nome do grupo aparece nos URLs de todas as páginas dentro do grupo.

É possível editar o slug do grupo para torná-lo mais curto que o nome do grupo. No entanto, em geral, isso não deve ser feito. Em vez disso, o nome do grupo deve ser o mais curto possível.