Справка:Соглашения по наименованию статей +
Материал из wiki.helpdesk.by
Содержание |
Статьи документации
Статьи документации должны именоваться по следующему принципу:
- Русскоязычная документация
- <Пространство имен>:Документация
- Англоязычная документация
- <Пространство имен>:Documentation
подстраницы документации являются подстраницами указанной статьи.
Например:
- Qt:Документация 4.3.2
- Qt:Документация 4.3.2/index
- GTK+:Документация 2.0.1
- GTK+:Документация 2.0.1/index
- Qt:Documentation 4.3.2
- Qt:Documentation 4.3.2/index
- GTK+:Documentation 2.0.1
- GTK+:Documentation 2.0.1/index
В случаях когда на основной странице нет никакого текста, например исходная страница документации по Qt это страница index, следует сделать перенаправление с основной страницы на исходную, например для Qt 4.3.2:
- Qt:Документация 4.3.2 - является перенаправлением на Qt:Документация 4.3.2/index
Пространство имен
Стандартные пространства имен включают:
- User - Содержит пользовательские страницы и подстраницы с начальными правками, или для собственных (относящихся к http://wiki.helpdesk.by ) нужд.
- User Talk - Используется для общения пользователей между собой.
- Template - Используется для шаблонов.
- Help - Статьи в помощь.
Префикс
Префиксы не используются, вместо них используются категории.
Категории
Избегайте создания статей без категорий. Подробности об использовании категорий смотрите в статье Категории
Недопустимые символы
Следующие символы нельзя использовать в названии статей:
- Двоеточие (:) - Используется для разделения имени статьи и пространства имени.
- Вперед наклонная черта (/) - Используется для создания подстраниц.
- Вопросительный знак (?) - Специальный символ в адресной строке браузера.
- Знак плюс (+) - Специальный символ в адресной строке браузера.
- Знак амперсанда (&) - Специальный символ в адресной строке браузера.
- Точка (.) - Может вызвать проблемы при создании ссылок
- Знак процента (%) - Специальный символ для кодирования символов
- Решетка (#) - Специальный символ в адресной строке браузера.
- Угловые скобки (< >) - Специальный символ в разметке wiki.
- Квадратные скобки ([ ]) - Специальный символ в разметке wiki.
- Вертикальная черта (|) - Специальный символ в разметке wiki.
- Фигурные скобки ({ }) - Специальный символ в разметке wiki.
- Собачка (@) - Специальный символ в строке брaузера
Общие пожелание по наименованию статей
- Имя страницы должно быть коротким
- Чувствительность К Регистру: очень важно - файлы идентифицируются при совпадении регистра.
- Желательно избегать обобщенных терминов, таких как "установка", "конфигурация", "Windows", или "linux"
- Имя страницы должно отражать содержание статьи.
- Если страница с таким именем уже существует, пожалуйста определитесь, можно дополнить существующую статью или можно переименовать одну из статей.
- Если вы решили переименовать уже написанную статью, пожалуйста в своей новой статье укажите местоположение/линк переименованной статьи в первых строках новой статьи.
Примеры удачных наименований страниц:
- Почтовый сервер на Postfix, Dovecot и DSpam
- Chroot из livecd
Примеры неудачных наименований страниц:
- Установка postfix, dovecot и dspam на VPS
- Chrooting установка Gentoo из под livecd
