Typographical Guidelines/ru: Difference between revisions
No edit summary |
(Updating to match new version of source page) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<languages /> | <languages /> | ||
<div class="mw-translate-fuzzy"> | |||
"Нами созданы отдельные страницы с описанием [[Special:myLanguage/PageLayout|компоновки страницы]] и [[Special:myLanguage/Toolbox|синтаксиса]] с кодом примеров." | "Нами созданы отдельные страницы с описанием [[Special:myLanguage/PageLayout|компоновки страницы]] и [[Special:myLanguage/Toolbox|синтаксиса]] с кодом примеров." | ||
</div> | |||
{{Remember|2=Важно|1=Выполнение приведенных на этой странице установок форматирования предоставит возможность аккуратно и без проблем экспортировать данные с целью включения в пакеты KDE. Некоторые из установок могут оказаться неприменимы к языкам, отличным от английского. Данные об этом можно найти на соответствующих страницах языков, ссылки на которые приведены на странице [[Special:myLanguage/Translation_Workflow|Translation Workflow]]. Если ссылки на страницу вашего языка еще нет, пожалуйста, добавьте его и выложите там наставления относительно форматирования страниц на вашем языке.}} | {{Remember|2=Важно|1=Выполнение приведенных на этой странице установок форматирования предоставит возможность аккуратно и без проблем экспортировать данные с целью включения в пакеты KDE. Некоторые из установок могут оказаться неприменимы к языкам, отличным от английского. Данные об этом можно найти на соответствующих страницах языков, ссылки на которые приведены на странице [[Special:myLanguage/Translation_Workflow|Translation Workflow]]. Если ссылки на страницу вашего языка еще нет, пожалуйста, добавьте его и выложите там наставления относительно форматирования страниц на вашем языке.}} | ||
== Links == | |||
Links to other UserBase pages should follow this pattern: | |||
{{Input|1=<nowiki>[[Special:MyLanguage/page name|whatever]]</nowiki>}} | |||
<nowiki>[[Special:MyLanguage/Welcome to KDE UserBase|start page]]</nowiki> links to the welcome page in the readers language if the translation exists or else to the english version of that page. | |||
Links to external pages follow normal wiki syntax: | |||
{{Input|1=<nowiki>[https://web.site.xxx/page text]</nowiki>}} | |||
==Bold Text== | ==Bold Text== | ||
Line 41: | Line 55: | ||
==Mono-spaced Text== | ==Mono-spaced Text== | ||
Code should be presented in mono-spaced text, usually boxed, as shown below. Input text will be on a | Code should be presented in mono-spaced text, usually boxed, as shown below. Input text will be on a light yellow background. For output text, the background colour will be a light grey. | ||
* Code, whether single lines or blocks, use templates to ensure consistency | * Code, whether single lines or blocks, use templates to ensure consistency | ||
Line 79: | Line 93: | ||
* Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}} It will <code>display</code> like this. Note, that if the <nowiki><code></nowiki> tag is immediately preceded by a newline character, it will not display properly. | * Single code words can be kept in-line by using {{Input|1=<nowiki><code></code></nowiki>}} It will <code>display</code> like this. Note, that if the <nowiki><code></nowiki> tag is immediately preceded by a newline character, it will not display properly. | ||
* File names and paths should use the Path template | * File names and paths should use the Path template (see below). | ||
{{Warning|1=In-line code markup should be short! It looks strange - and ugly - if a string of code words is split between lines. And remember: even if it looks good in your browser, not everyone uses the same screen size! And even if your text looks good on all screen sizes translations may still suffer. It is best to use the Input template for code unless it is really short.}} | {{Warning|1=In-line code markup should be short! It looks strange - and ugly - if a string of code words is split between lines. And remember: even if it looks good in your browser, not everyone uses the same screen size! And even if your text looks good on all screen sizes translations may still suffer. It is best to use the Input template for code unless it is really short.}} | ||
Line 98: | Line 112: | ||
Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect. | Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect. | ||
<span id="Lists"></span> | |||
==Lists== | ==Lists== | ||
You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the [[Special:myLanguage/Toolbox#Bulleted Lists|Toolbox]] page. | You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the [[Special:myLanguage/Toolbox#Bulleted Lists|Toolbox]] page. | ||
<span id="Keeping things together"></span> | |||
==Keeping things together== | ==Keeping things together== | ||
Line 108: | Line 122: | ||
If you need a linebreak in the middle of a section, the preferred way to achieve this without breaking units is to use <nowiki><br /></nowiki> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <nowiki><br /><br /></nowiki>. | If you need a linebreak in the middle of a section, the preferred way to achieve this without breaking units is to use <nowiki><br /></nowiki> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <nowiki><br /><br /></nowiki>. | ||
<span id="Unbalanced brackets"></span> | |||
==Unbalanced brackets== | ==Unbalanced brackets== | ||
Line 120: | Line 134: | ||
==Special Tags== | ==Special Tags== | ||
=== Key presses and menu selections === | |||
* <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap> | * <nowiki> <keycap></nowiki> and <nowiki> </keycap> </nowiki> denote (keyboard) key names e.g. <keycap>Enter</keycap> | ||
Line 125: | Line 141: | ||
* Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice> | * Sequences of menu choices should use <nowiki> <menuchoice> </nowiki>and <nowiki> </menuchoice> </nowiki> for example <menuchoice> View -> Message List -> Aggregation -> Standard Mailing List </menuchoice> | ||
* In general, if the user needs to choose an element, even if it is not in a menu, the <nowiki><menuchoice></menuchoiсe></nowiki> markup should be used. | * In general, if the user needs to choose an element, even if it is not in a menu, the <nowiki><menuchoice></menuchoiсe></nowiki> markup should be used. | ||
* If you are contributing to a manual page, you should always use the markup describes above. For other pages, though, there is a template to enter menu selections: <nowiki>{{Menu|Top|sub|...}}</nowiki>. Fx, <nowiki>{{Menu | View | Message List | Aggregation | Standard Mailing List}}</nowiki> yields {{Menu | View | Message List | Aggregation | Standard Mailing List}} | |||
* If you want to use the <nowiki><menuchoice></nowiki> but use → in stead of ->, you write <code>& rarr;</code> (without a space between '&' and r!) as in <nowiki><menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice></nowiki> which yields <menuchoice> View</menuchoice> → <menuchoice>Message List</menuchoice>. (Note, that the → character has to be outside of the menuchoice tags to be shown properly | |||
=== Files and file paths === | |||
Traditionally, file names and paths have been marked up between <nowiki><tt>...</tt></nowiki> tags. | |||
{{Input|1=<nowiki><tt>~/.kde/share</tt></nowiki>}} | |||
yields | |||
{{output|1=<tt>~/.kde/share</tt>}} | |||
There is now also a template for this, which should be preferred in new content for ordinary UserBase pages (but not for manual pages, please!): | |||
{{Input|1=<nowiki>{{Path | ~/.kde/share }}</nowiki>}} | |||
yields | |||
{{Output|1={{Path | ~/.kde/share }} }} | |||
== The Problematic Pipe == | == The Problematic Pipe == |
Latest revision as of 05:05, 19 May 2024
"Нами созданы отдельные страницы с описанием компоновки страницы и синтаксиса с кодом примеров."
Links
Links to other UserBase pages should follow this pattern:
[[Special:MyLanguage/page name|whatever]]
[[Special:MyLanguage/Welcome to KDE UserBase|start page]] links to the welcome page in the readers language if the translation exists or else to the english version of that page.
Links to external pages follow normal wiki syntax:
[https://web.site.xxx/page text]
Bold Text
Use bold text to highlight
- Window titles
- Common labels that are not user-configurable
- Icon captions
- Program names
For example:
- Highlighting a selection of text will copy it to Klipper.
Italic Text
Use italic text to emphasise
- Words or phrases as in general writing.
- Titles when referencing other works.
- The first use of an unfamiliar word.
Some examples:
- Save your work at this point.
- Details can be found in Samba 3 by Example....
- KDE Manuals are in Docbook format.
Combined Bold and Italic Text
Use this combination for replaceable or variable text.
Some examples:
- To connect to your remote server, type
ssh
[email protected] in Konsole. - In rpm-based distributions, the command
rpm -q
packagename will result in package-version-release.
Mono-spaced Text
Code should be presented in mono-spaced text, usually boxed, as shown below. Input text will be on a light yellow background. For output text, the background colour will be a light grey.
- Code, whether single lines or blocks, use templates to ensure consistency
- Use the Input template like this:
{{Input|1=<nowiki> qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver</nowiki>}}
This will display like this:qdbus org.kde.NepomukServer /nepomukserver org.kde.NepomukServer.quit rm -r ~/.kde/share/apps/nepomuk rm -r ~/.kde4/share/apps/nepomuk nepomukserver
- Output works the same way:
{{Output|1=<nowiki>terminal output is also shown as code, but on a grey background</nowiki>}}
which displays asterminal output is also shown as code, but on a grey background
- Starting an Input or Output template on a new line will break the display format if it is within lists. Simply continue on the same line if you need to correct this.
- You can also combine input/output areas with GeSHi syntaxhiglighting. An input area like this
{{Input|<syntaxhighlight lang="php" line> # Initialise common code $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" ); </syntaxhighlight>}}
will result in# Initialise common code $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" );
- Single code words can be kept in-line by using
<code></code>
It willdisplay
like this. Note, that if the <code> tag is immediately preceded by a newline character, it will not display properly.
- File names and paths should use the Path template (see below).
Block Quotes
The tags <blockquote> and </blockquote> should be used when quoting other works or other pages. This produces a proportional italic font, with some padding.
Here is an example of the display that you get by using the blockquote tags.
Text in Section Headers
Even though the criteria above may be met, do not use Bold text in section headers or in links.
Text in Information, Note, Tip or Warning Templates
Bold text should be avoided in the text within these templates. Italic text for emphasis may still be used - use sparingly for maximum effect.
Lists
You can have various kinds of lists in your pages — bulleted, numbered or itemized. Find details on the Toolbox page.
Keeping things together
After your text is written some markup is automatically added by the translation system. This means that whenever it sees a blank line, it starts a new unit. When your text is presented to translators, they typically see it one unit at a time, so it is important not to leave a blank lines in the middle of something that should be treated as a unit. Normally an entire paragraph should be kept in a single unit; and under no circumstance should a sentence be split between units!
If you need a linebreak in the middle of a section, the preferred way to achieve this without breaking units is to use <br /> at the end of the line where you want to break to occur (not on a new line). If you need space between the lines add <br /><br />.
Unbalanced brackets
The translation system marks any translated unit as incompletely translated if it contains any kind of unbalanced brackets. If you need to have unbalanced brackets in your text, please add a balancing bracket in a comment tag, like this:
<!-- }} -->{{ A line Another line}}<!-- {{ -->
This goes for all kinds of brackets, even ordinary parentheses. (Of course it is normally better to avoid blank lines within a mark up unit - see Keeping things together.)
Special Tags
- <keycap> and </keycap> denote (keyboard) key names e.g. Enter
- <keycap></keycap> can also be used around groups of keys to be used concurrently, e.g. Ctrl + Alt + F1 to launch a virtual terminal. (Note that "(space)+(space)" is used to link keys to be pressed concurrently).
- Sequences of menu choices should use <menuchoice> and </menuchoice> for example
- In general, if the user needs to choose an element, even if it is not in a menu, the <menuchoice></menuchoiсe> markup should be used.
- If you are contributing to a manual page, you should always use the markup describes above. For other pages, though, there is a template to enter menu selections: {{Menu|Top|sub|...}}. Fx, {{Menu | View | Message List | Aggregation | Standard Mailing List}} yields → → →
- If you want to use the <menuchoice> but use → in stead of ->, you write
& rarr;
(without a space between '&' and r!) as in <menuchoice> View</menuchoice> & rarr; <menuchoice>Message List</menuchoice> which yields → . (Note, that the → character has to be outside of the menuchoice tags to be shown properly
Files and file paths
Traditionally, file names and paths have been marked up between <tt>...</tt> tags.
<tt>~/.kde/share</tt>
yields
~/.kde/share
There is now also a template for this, which should be preferred in new content for ordinary UserBase pages (but not for manual pages, please!):
{{Path | ~/.kde/share }}
yields
~/.kde/share
The Problematic Pipe
In some situations the pipe symbol can't be used - for instance when adding parameters into a template. In any such case, please use {{!}} which will display as a pipe symbol. For example, if you want to display a command line containing the pipe character using the {{Input|...}} template, the simplest way to do it is this: {{Input|1=cmd1 {{!}} cmd2}}
which displays
cmd1 | cmd2
If you just write {{Input|cmd1 | cmd2}}
you get instead
cmd1
the problem being, that cmd2
is seen as a second parameter to the template, which in this case is not used.
In many cases, you can also enclose the text containing the pipe character between <nowiki>... </nowiki> tags, like this {{Input|1=<nowiki>cmd1 | cmd2</nowiki>}}
, which also displays
cmd1 | cmd2
Translatable Content
Everything that is translatable is contained within <translate> and </translate> tags. In most cases any images should be contained within the translatable section, as it is sometimes necessary to use localised versions of the images to explain a point. The rule of thumb is "If in doubt, include it!".