Справка:Правила именования статей

Материал из Wiki.crossplatform.ru

(Различия между версиями)
Перейти к: навигация, поиск
(Статьи документации: опечатка и дополнение)
 
(3 промежуточные версии не показаны)
Строка 2: Строка 2:
# "Введение в Qt", "Документация Qt" и т.п.
# "Введение в Qt", "Документация Qt" и т.п.
# "Введение (Qt)", "Документация (Qt)" и т.п.
# "Введение (Qt)", "Документация (Qt)" и т.п.
 +
 +
== Статьи документации ==
 +
Статьи документации должны именоваться по следующему принципу:<br />
 +
* Русскоязычная документация
 +
** <Пространство имен>:'''Документация''' <версия>
 +
* Англоязычная документация
 +
** <Пространство имен>:'''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]]
 +
 +
[[Категория:Справка]]
[[Категория:Справка]]

Текущая версия на 07:33, 26 октября 2008

Название статьи должно быть кратким, но при этом понятным. Если название статьи может быть неоднозначным. Т.е. применимо к любой библиотеке, рассматриваемой в нашей вики, то использовйуте подсказку/оговорку. Например, если статья относится к Qt, и предпологается название "Введение", "Документация" и т.п., то т.к. оно применимо и для Qt и для GTK+ и других библиотек, то надо использовать один из вариантов названий:

  1. "Введение в Qt", "Документация Qt" и т.п.
  2. "Введение (Qt)", "Документация (Qt)" и т.п.

[править] Статьи документации

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

  • Русскоязычная документация
    • <Пространство имен>:Документация <версия>
  • Англоязычная документация
    • <Пространство имен>: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: