Страница Help:Editing на Mediawiki.org -- хороший источник информации по вики разметке. Справочная карта также является отличным источником информации.
- Страницы на русском
Основной синтаксис
| Введенный текст | Выглядит так |
|---|---|
'''жирный шрифт''' |
жирный шрифт |
''курсив'' |
курсив |
'''''жирный курсив''''' |
жирный курсив |
<code>моноширинный шрифт</code> |
моноширинный шрифт
|
Списки
| Введенный текст | Выглядит так |
|---|---|
* Элемент списка * Другой элемент списка ** Элемент вложенного списка |
|
# Элемент пронумерованного списка # Другой элемент пронумерованного списка ## Первый элемент вложенного упорядоченного списка ## Второй элемент вложенного упорядоченного списка # Третий элемент пронумерованного списка |
|
* Элемент неупорядоченного списка... *# ... с вложенным упорядоченным списком *# продолжение упорядоченного списка * Второй элемент неупорядоченного списка *# Новый упорядоченный список *#* ... с собственным вложенным списком |
|
Ссылки
| Введенный текст | Выглядит так |
|---|---|
Перейдите на страницу [[L10N/Teams/Russian| русской команды]] для получения информации о переводе Fedora на русский язык. |
Перейдите на страницу русской команды
для получения информации о переводе Fedora на русский язык. |
На странице [[Ru_RU/MonthlyTasks]] можно просмотреть список задач на следующий месяц. |
На странице Ru_RU/MonthlyTasks можно просмотреть
список задач на следующий месяц. |
Прочитайте инструкции [[Ru_RU/L10N/Glossary#Instruction]] по добавлению новых терминов в словарь. |
Прочитайте инструкции Ru_RU/L10N/Glossary#Instruction
по добавлению новых терминов в словарь. |
Страница [[Погода в Москве]] не существует. |
Страница Погода в Москве не существует. |
http://fedoraproject.org/ |
http://fedoraproject.org/ |
Ссылки на сайты: [http://www.russianfedora.ru/] [http://www.flickr.com] |
Ссылки на сайты: [1] [2] |
[http://fedoraproject.org Домашняя страница] Проекта Fedora. |
Домашняя страница Проекта Fedora. |
Добавьте ':' для ссылки на [[:Image:Growth_wide.jpg|изображение]]. |
Добавьте ':' для ссылки на изображение. |
[[:Category:LocalizationRussian]] содержит список всех страниц на русском языке. |
Category:LocalizationRussian содержит список всех страниц на русском языке. |
Добавьте [[Category:LocalizationRussian]] в конец страницы, чтобы добавить ее в список русских страниц. |
Добавьте [[Category:LocalizationRussian]] в конец страницы,
чтобы добавить ее в список русских страниц. |
Укажите двоеточие перед словом "Category" при создании ссылки на страницу категории. Если страница уже принадлежит этой категории, двоеточие можно опустить (см. примеры выше).
Таблицы
Таблицы должны использоваться лишь при необходимости.
Подробную информацию о работе с таблицами можно найти на сайте Mediawiki.org.
| Структура | Текст ввода |
|---|---|
| Начало таблицы | {|
|
| Заголовок таблицы | ! Столбец 1 !! Столбец 2 !! Столбец 3 |
| Строка таблицы | |- |
| Данные таблицы | | Ячейка 1 || Ячейка 2 || Ячейка 3 |
| Конец таблицы | |} |
Текст IRC
Для выделения вывода IRC используйте теги <pre> или преобразуйте его стиль в таблицу с помощью irclog2html и исправления для irclog2html.
Примечания, советы, и другое выделение текста
Которые в целом известны как замечания и используются в DocBook. Для преобразования текста используется специальный формат:
| Введенный текст | Выглядит так |
|---|---|
{{admon/note|Заголовок замечания|Здесь содержится подробный текст замечания.}}
|
Заголовок замечания
Здесь содержится подробный текст замечания. |
Отступ начального и второго параграфа на один пробел гарантирует, что рамка будет правильно выровнена.
Ниже приведены стандартные виды замечаний:
| Введенный текст | Выглядит так |
|---|---|
{{admon/note|Замечание|Здесь содержится подробный текст замечания.}} |
Замечание
Здесь содержится подробный текст замечания. |
{{admon/tip|Подсказка|Здесь содержится подробный текст подсказки.}} |
 Подсказка
Здесь содержится подробный текст подсказки. |
{{admon/important|Важно|Здесь содержится важная информация, на которую следует обратить внимание.}} |
 Важно
Здесь содержится важная информация, на которую следует обратить внимание. |
{{admon/caution|Осторожно|Здесь содержится подробная информация.}} |
.png){kind=small} Осторожно
Здесь содержится подробная информация. |
{{admon/warning|Предупреждение|Здесь содержится полный текст предупреждения.}} |
 Предупреждение
Здесь содержится полный текст предупреждения. |
Примеры примечаний
В Википедии рассказывается о высоте обрывов.
Подробную информацию можно найти на странице
cliffs(1).Дети достатчно подвижны и могут сорваться. Держите их за руку.
Как уже говорилось, высота обрывов может быть достаточно большой, а сорваться никому не хочется.
Отойдите от края во избежание падения.
Руководство по документированию Fedora содержит подробное описание типов замечаний:
http://docs.fedoraproject.org/documentation-guide/en_US/sn-xml-admon.html
Плашки
Плашки можно использовать, когда вы по каким-либо причинам не в состоянии устранить недостаток в переводе.
| Введенный текст | Выглядит так |
|---|---|
{{Update/ru}} |
 Эта страница давно не обновлялась
Данную статью желательно обновить, дополнить, привести в соответствие с оригиналом или переместить в архив. |
{{RoughTranslation/ru}} |
 Грубый перевод
Некоторые слова или предложения в этом тексте звучат не по-русски. Помогите, пожалуйста, исправить статью так, чтобы ее чтение было легким и непринужденным. |
{{RoughTranslation/ru|эгразеба}} |
Грубый перевод
Некоторые слова или предложения в этом тексте звучат не по-русски. В частности, «эгразеба». Помогите, пожалуйста, исправить статью так, чтобы ее чтение было легким и непринужденным. |
{{CleanupRemainder/ru}} |
 Информацию ниже желательно почистить от лишнего и освежить
Если не трудно, помогите, пожалуйста, улучшить статью. При работе можно поэтапно сдвигать эту плашку вниз к концу страницы. |
Запись примеров команд
Примеры команд содержат одну или несколько команд не считая пояснений. В тексте команд не используйте название компьютера, каталога или имени пользователя, то есть информацию из переменной окружения $PS1.
Примеры команд заключите в теги <pre></pre>:
<pre> su -c "yum install awesome-application" </pre> Enter the <code>root</code> password when prompted.
Текст будет выглядеть так:
su -c "yum install super-application" Enter the root password when prompted.
root Многие команды требуют привилегий
root. Пользователи не должны заходить в свою систему как root, а рекомендуется указать su -c или su - при указании административных команд.Если текст команды содержит кавычки, вложение будет выглядеть так: " ' ' ", где одинарные кавычки заключены в двойные.
Пример:
su -c "command -o 'Какой-то текст' -file 'Еще текст' foo/bar"
При наличии целого набора команд можно предложить пользователю перейти в режим root и по завершению напомнить вернуться в обычный режим.
su - Password: service food stop cp /etc/foo.d/foo.conf /etc/foo.d/foo.conf.backup vi /etc/foo.d/foo.conf food --test-config ... service food start exit
Вывод команды
Если текст демонстрирует команду как часть вывода на экран, можно добавить строку приглашения.
$ su -c "ls -l /root" Password: total 148 -rw------- 1 root root 1961 2007-09-21 02:46 anaconda-ks.cfg -rw-r--r-- 1 root root 46725 2007-09-21 02:46 install.log -rw-r--r-- 1 root root 6079 2007-09-21 02:42 install.log.syslog -rw-r--r-- 1 root root 3699 2008-07-28 17:24 scsrun.log -rw-r--r-- 1 root root 45038 2008-01-10 10:21 upgrade.log -rw-r--r-- 1 root root 1317 2008-01-10 10:20 upgrade.log.syslog
Советы
Здесь приведены основные правила, которых стоит придерживаться при редактировании Вики.
о создании вики-документации рассказывается здесь.
Структура вики-страниц
Этот раздел описывает общую структуру вики-страниц. Придерживайтесь этих указаний при создании и правке вики-страниц. Существуют дополнительные правила для официальной документации Fedora, описанные на странице DocsProject/WritingUsingTheWiki ; эти правила позволяют следовать правилам оформления содержимого при документировании Fedora .
Заголовок страницы является заголовком первого уровня. При создании и переносе страниц убедитесь, что они содержат ТОЛЬКО заголовки второго уровня.
- Заголовок страницы является заголовком первого уровня и создается автоматически.
- Для форматирования секций используйте знаки равенства:
== Заголовок 2 == === Заголовок 3 === ==== Заголовок 4 ==== ===== Если требуется 5 уровней вложения, лучше создать новую страницу =====
- Содержание страницы генерируется автоматически и заполняется по ходу наполнения страницы.
- Якоря для секций также генерируются автоматически. При этом пробелы и знаки препинания заменяются специальными символами:
Моя страница ==> Моя_страница Страница про одно, второе и немного третьего ==> Страница_про_одно,%2C_второе_и_немного_третьего
При создании якоря для секции можно заменить '%' на точку.
Учитесь на примерах
Одним из лучших способов изучить способы редактирования вики-страниц является просмотр исходного кода уже существующих страниц. Это очень просто сделать:
- Найдите страницу, исходный код которой хотите просмотреть.
- Вверху страницы нажмите править.
Будет показан текст этой страницы. Это особенно ценно при изучении некоторых трюков, уже использующихся вики-авторами, что позволит применять уникальные, интересные приемы, о которых вы и не подозревали. Попробоуйте ознакомиться с кодом страницы Ru_RU (не вносите кардинальных изменений!).
Выделение технических терминов
Используйте разметку code (<code></code>), чтобы отметить имена приложений, файлов, каталогов, пакетов программ, учетных записей пользователя и других слов, которые имеют технический смысл. Это отобразит выделенный таким образом текст моноширным шрифтом.
Используйте пары одинарных кавычек (''[элемент меню]''), чтобы отметить пункты меню и другие элементы графического интерфейса. Это выделяет текст курсивом.
Элемент
Разметка
Пример форматирования
Название GUI приложения
'''полужирный'''
Firefox
Файлы, каталоги
<code>вложенные теги code</code>
/usr/bin/firefox
Пакеты программ
<code>имя пакета</code>
firefox-1.2.3
Учетная запись пользователя
<code>пользователь</code>
username
Другой технический текст
<code>технический термин</code>
someJava.classname
Графические меню и пункты меню
''меню''
Приложения > Интернет > Firefox Web Browser
Другие GUI или Веб-UI элементы
''курсив''
... нажмите кнопку Подтвердить ...
Команды и демоны
<code>параметр команды</code>
grep httpd, чтобы найти PIDs запущенных httpd процессов.
Секции кода, файлы конфигурации и т.п.
<pre>пробелы сохраняются</ pre>
здесь
пробелы сохранены
Вложенные секции кода, файлы конфигурации и т.п.
<code>пробелы не сохраняются</code>
... Затем измените переменные set() в /path/to/org/dev108/classname ...
Первый термин, термин из глоссария
''термин''
... Firefox является примерм графического интерфейса пользователя (GUI).
Комбинации клавиш
'''[Клавиша] '''
Нажмите клавишу[Enter] ...
Например:
<code>thunderbird</code> пакет устанавливает почтовый клиент '''Mozilla Thunderbird'''. Чтобы запустить '''Thunderbird''', выберите: ''Приложения > Интернет > Thunderbird Email''.
Текст будет выглядеть так:
thunderbird пакет устанавливает почтовый клиент Mozilla Thunderbird. Чтобы запустить Thunderbird, выберите: Приложения > Интернет > Thunderbird Email.