Tyyliohje

General

Case

Kaikki teksti on kirjoitettava lauseissa isolla alkukirjaimella. Tämä koskee kaikkia kappaleita, otsikoita ja sivujen otsikoita.

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.

Erisnimet ja lyhenteet kirjoitetaan isolla alkukirjaimella Wikipedia-sivulla käytetyn kyseisen aiheen muodon mukaisesti.

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

Arkikielen lyhenteitä ei tule kirjoittaa isolla alkukirjaimella.

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

UI labels

Käyttäjälle ohjeita kirjoitettaessa MuseScoren käyttöliittymässä näkyvä teksti tulee kopioida sanatarkasti, isot kirjaimet mukaan lukien, ja korostaa lihavoituna ilman lainausmerkkejä.

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

Tarvittaessa tavalliseen tekstiin voidaan lisätä hyperlinkkejä avainsanoihin tai -lausekkeisiin, jotka tulee kirjoittaa niin, että ne ovat ymmärrettäviä ilman linkkiäkin. Yleensä koko URL-osoitetta ei tule näyttää.

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

Katso tutoriaali täältä. ❌ Teksti ei olisi järkevää, jos linkki poistettaisiin

Katso se osoitteessa https://www.youtube.com/watch?v=z4Ecaaqwg8U. ❌ Älä näytä URL-osoitetta

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

Pikanäppäimet tulee muotoilla seuraavasti:

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

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

Muokkaajat tulee kirjoittaa tässä muodossa ja tässä järjestyksessä kullekin alustalle:

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.

Tulostettavia merkkejä kirjoittavat näppäimet tulisi esittää kyseisellä merkillä.

. , ; ' [ ] / \ - = ` 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

Katselet parhaillaan [Tyyliopas](style-guide.md)-sivua, joka on [Tietoja käsikirjasta](./) -sivun alasivu.

Page titles

Sivujen otsikoiden tulisi olla suhteellisen lyhyitä. Ihannetapauksessa otsikon tulisi mahtua yhdelle riville yhteenvedossa näytön vasemmalla puolella, vaikka tämä ei aina ole mahdollista. Muista, että sivujen otsikot voivat olla huomattavasti pidempiä, kun ne käännetään muille kielille kuin englanniksi.

Vinkkejä sivun otsikoiden pitämiseen lyhyinä:

• Vältä käyttämästä sanaa "partituuri" (esim. "Elementtien valinta", ei "Elementtien valinta partituurista")

• Vältä käyttämästä sanaa "MuseScore" (esim. "Päivitetään", ei "Päivitetään MuseScore Studiota")

Subpages

Kun käytetään alasivuja, vain yhtä alasivutasoa saa käyttää. Älä koskaan luo alasivua.

Yläsivujen otsikoiden tulisi olla hyvin lyhyitä, koska niiden otsikot näkyvät kaikkien alasivujen URL-osoitteissa.

Yleensä käytämme mieluimmin ryhmiä kuin alasivuja, jotta vältetään sisäkkäisyyttä yhteenvedossa.

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.

Ryhmien nimien tulisi olla hyvin lyhyitä. Tämä johtuu siitä, että ryhmän nimi näkyy kaikkien ryhmän sivujen URL-osoitteissa.

Ryhmää voidaan muokata lyhyemmäksi kuin varsinainen ryhmän nimi. Yleensä tätä ei kuitenkaan pitäisi tehdä. Sen sijaan ryhmän nimi tulisi pitää mahdollisimman lyhyenä.