SDB:Howto

Материал из openSUSE.

Эта статья содержит фрагменты на иностранном языке . Вы можете помочь проекту, переведя её до конца.

Ситуация

Эта статья объясняет как писать статьи для SDB (support database).

Процедура

SDB статьи пишутся чтобы помочь в решении проблем с SUSE Linux, а также, чтобы дать более подробное объясение определенных вопросов. Если у вас проблемы с SUSE Linux, тогда SDB - это как раз место для поиска помощи.

Статьи SDB содержат:

• Ситуация
• Процедура
• Ссылки

или

• Симптомы
• Причина
• Решение
• Ссылки

Обратите внимание, что статьи SDB должны (по возможности) содержать наиболее простое решение проблемы. Однако желательно также показывать наиболее быстрое решение которое может быть достигнуто только с помощью командной строки или редактирования конфигурационных файлов. В этом случае раздел "Решение" необходимо разбить на несколько подразделов. Перед тем, как перейти к деталям, касающимся синтаксиса, вот пример статьи (чтобы увидть этот пример как статью, перейдите на страницу SDB:Changing NTP Server - SDB Example).

Пример статьи

<!-- SDB information
SDB:title: Changing NTP Server - SDB Example 
SDB:author: mlasars
SDB:date: 2005-10-17 -->

 Version: 9.0

[[Category:SDB:Network|N]]
[[Category:SDB:9.0|N]]

Это пример статьи SDB.

== Ситуация ==

Вы настроили часы на вашем компьютере с использованием ntp,
но выбранный сервер больше недоступен.

== Процедура ==

Эта статья описывает несколько решений:

=== С помощью YaST2 ===

Запустите YaST2, выберите "Network Services" и затем запустите модуль
"NTP Client". В поле "Select" выберите "public server". Выберите
из списка вашу страну или ближайшую к вам, после чего на второй панели
выберите сервер. После этого нажмите "Test" и, если тест прошел успешно,
нажмите "Ок". Завершите кофигурирование нажатием "Finish"

=== С помощью командной строки ===

Откройте файл <code>/etc/sysconfig/ntp</code> и измените значение переменной
<code>NTPD_INITIAL_NTPDATE=""</code> на сервер, который вы выбрали. Затем
перезапустите ntp с помощью команды

 rcntpd restart

== Ссылки ==
[[SDB:Time Synchronization Through the Network]]

<keyword>ntp,xntp,time,synchronize</keyword>
[[en:SDB:ntp_server_change(example)]]

Создание новой статьи

В вашем web-браузере, войдите в название новой статьи после SDB: в строке URL. Если статья не существует, или необходимо внести изменения, щелкните "edit" чтобы создать или редактировать её. Пожалуйста не переписывайте существующие статьи. В случае необходимости, добавьте число версии или "(new)" к названию.

Все статьи SDB должны начаться с SDB:, это делает поиск их легче и составляет отдельную секцию в Wiki.

Заключение

История

Когда Вы закончили редактировать вашу статью, пожалуйста добавьте это к SDB:History. Используйте этот синтаксис:

YYYYMMDD [[SDB:<articlename>]]

Например:

20051016 [[SDB:Howto]]

Пожалуйста используйте международный формат даты. Список сортирован в порядке убывания, так, чтобы новые статьи были всегда наверху списка.

Если Вы сделали существенные изменения к статье, как обновление этого для более новой версии, пожалуйста также упомяните это в Истории. Меньшие изменения или дополнения не должны быть добавлены к Истории.

Переводы

В настоящее время openSUSE wiki поддерживает английский, немецкий, французский и испанский язык. Если Вы любите, и если Вы знаете один из этих языков, пожалуйста переведите вашу статью. Если Вы не делаете, или не уверены, достаточно ли Вы быстры на иностранном языке, пожалуйста напишите электронную почту opensuse-wiki списку адресатов, и спросите кого - то, чтобы перевести вашу статью.

Если Вы перевели статью, пожалуйста добавьте связи "Interwiki" в конце статьи. Как пример, если Вы перевели статью с немецкого языка:

[[en:SDB:<articlename>]]

К английской версии, добавьте следующее:

[[de:SDB:<articlename>]]

В настоящее время следующие сокращения поддержаны:

de German
en English
fr French
es Spanish

Изменения существующих статей

With the integration of the SDB into the openSUSE Wiki it is now possible to edit all articles. If you want to change an article substantially it might be a good idea to discuss this first with the original authors. Please use the "discussion" link shown at the bottom of every article to do this.

This is not compulsory, but it makes Wiki collaboration easier and more enjoyable. If you cannot agree on a solution, maybe an email to the opensuse-wiki mailing list can help to clarify the situation.

Smaller changes may be made without discussion.

Теги SDB

Содержание

As soon as an article contains three or more sections marked with === Section ===, the wiki software automatically generates a table of contents. This means that if you use the standard SDB article outline "Situation, Procedure, Links", this happens automatically.

Мета-информация SDB

Пожалуйста, включайте следующую мета-информацию в заголовок новой статьи. Отображаться она не будет.

<!-- SDB information
SDB:title: Changing NTP Servers - SDB Example 
SDB:author: mlasars
SDB:date: 2005-10-17 -->

Если Вы вносите в статью существенные изменения, пожалуйста, внесите свое имя пользователя в список авторов, через запятую. Не изменяйте содержимое других полей мета-информации, особенно SDB:date. Все изменения, внесенные в статью, могут быть просмотрены в Истории Изменений. Мета-информация используется для сохранения самых важных данных прямо в статье в случае реорганизации системы в будущем.

Версия

Пожалуйста, в начале статьи определяйте версию(ии) SUSE Linux для которых она применима . Возможно несколько вариантов:

Version: 8.0
Version: - 8.0
Version: 8.0 -
Version: 8.0 - 8.1

Если статья не является относящейся к конкретной версии, просто пропустите тэг версии. Если она применима только для конкретной архитектуры или варианта SUSE Linux пожалуйста, указывайте и это:

Version: 9.2 x86_64
Version: 9.1 DVD
Version: 10.0 ppc

В настоящее время SUSE Linux поддерживает следующие архитектуры: i386, x86_64 (64 бит, AMD64 и Intel EM64T) и ppc (PowerPC (Mac)). Вы можете определить один из следующих вариантов: Box (ретейл-версия), FTP, CD, DVD и OSS.

Пожалуйста, добавляейте этот тэг только если проблема носит специфицеский для данного варианта характер. Примечание: для того, чтобы вокруг номера версии рисовывалась красивая рамочка, пожалуйста, начинайте строку номера версии с пробела.

Категории

Every SDB article should be accessible through the categories. You can find a list of available categories at Category:SDB. Add the categories at the beginning of the article:

[[Category:SDB:8.0|C]]
[[Category:SDB:Network|C]]

The category is followed by a pipe character and the first character of the title. In the example above, the article is called "Changing NTP Servers", so the pipe character is followed by a "C".

Ключевые слова

Add all keywords that you want your article to be associated with to the end of the article:

<keyword>ntp,time,xntp,synchronize</keyword>

You can use anything you like as keywords.

Синтаксис

Apart from the Wiki-Syntax, MediaWiki also supports plain HTML tags. Whenever possible please use Wiki markup, so that the article sources are easier to read and edit. The most important elements of Wiki markup are given below. For more detailed instructions, see: http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page.

Секции

• Level 1: == Top Level Header == (for Situation, Procedure, Links)
• Level 2: === Subheader === (z.B. for YaST2, Command line)
• Level 3: ==== one level below ==== (more subsections, e.g. different versions)

Situation and Procedure should always use the top-level header, other subsections are one level below that, and so on.

Форматирование

You don't have to mark paragraphs with <p>paragraph</p> as you would in HTML, this is done automatically. Paragraphs are separated with two empty lines.

  
This is the first paragraph
which can be written in several lines.


This is the second paragraph.

Текст (жирный, наклонный, моноширинный)

To highlight paragraphs or words please use the following syntax:

Перечисления / списки

Examples for enumerations:

* Planets
** Mars
** Earth
*** Moon

#Travel
## Plane
## Car
### Taxi

For the links at the end of an article please use * Link without further subdivision.

Комманды и выдержки из файлов конфигурации

Lines containing a single command should start with a space

rcapache2 restart

to highlight the command. Commands included in normal text should use <code>command</code>.

For code listings and config files please use the following syntax:

<pre>
## Path:        Network/Remote access/SSH
## Description: SSH server settings
## Type:        string
## Default:     ""
## ServiceRestart: sshd
#
# Options for sshd
#
SSHD_OPTS=""
</pre>

## Path:        Network/Remote access/SSH
## Description: SSH server settings
## Type:        string
## Default:     ""
## ServiceRestart: sshd
#
# Options for sshd
#
SSHD_OPTS=""

nowiki

In certain situations you might want to disable wiki markup:

Ссылки

Links to other SDB articles start with SDB: [[SDB:howto]], but it is not necessary to explicitly include a link label. It is also possible to jump to a specific location in the article, e.g. [[SDB:howto#Stil]], which will be displayed as SDB:howto#Stil. If you use these direct links to a section of an article, adding the link label may be helpful: [[SDB:howto#Stil|Stil]] will be displayed as Stil.

External links should have a link label if it isn't obvious what they point to, or to make the link shorter.

[http://www.suse.de SUSE] will be displayed as SUSE. In this case, link and link label are simply separated by a space.

Please note that in some countries, external links may be a violation of local laws. As an example, it is illegal in Germany to link to software which may be used to circumvent copy-protection technology. If you are unsure if you can use a certain link, please ask on the opensuse-wiki mailing list (see Communicate).

Таблицы

See http://en.wikipedia.org/wiki/Wikipedia:How_to_use_tables

Изображения

Up till now, SDB articles have not used images. Please use them only where necessary, in order not to disturb the layout and flow of the article. If possible, just include a preview of the image at the right margin of the article. For more information about uploading images to the Wiki see: http://en.wikipedia.org/wiki/Wikipedia:Image_markup.

Стиль

Как обращаться к читателю

German SDB articles should use the polite form of address with "Sie", as this is the standard in technical documentation. If this applies to your language, please use the polite form, too. English authors of course don't have that problem ;-).

Термины на инстранных языках

In languages other than English, it is sometimes difficult to do without the original english technical terms. Please try to write such in a way that the broadest group of SDB users will find your article useful, but do not try to find translations when the English terms are commonly understood and used in the target language. A good compromise may be to use both, like in this german example: : "gehen Sie auf die zweite console (Kommandozeile) mit STRG-ALT-F2"

Простота!

Even if using the shell sometimes seems easier, especially for you, please try to keep Linux beginners in mind and also explain how a problem can be solved with YaST2 or other tools.

A good SDB article should describe every single step. So, don't write:

In /etc/inittab, change the default runlevel to 3.

but:

Log in as the root user and open the file /etc/inittab with the
editor of your choice (e.g. vi or pico). Change the line
id:5:initdefault: to id:3:initdefault: so that the system won't boot
into the graphical user interface any more.

This is not meant to be a hard requirement! But please remember that many Linux newbies use SUSE Linux, too.

Поддержка

Часто необходимо обновлять SDB статьи в связи с выходом новых версий SUSE Linux, или даже писать новые, если внесенные изменеия слишком фундаментальны. Пожалуйста, старайтесь поддерживать свои SDB статьи. Например, если Вы заметили, что Ваша статья больше не соответсвует последней версии SUSE Linux, пожалуйста измените строку "версия"("version").

Ссылки

• http://en.wikipedia.org/wiki/Wikipedia:How_to_edit_a_page