Рекомендации для пишущих и исправляющих

Сначала читаем синтаксис. Также поглядите в черновике, может там чет полезное найдете. Для тех кому не хватит стандартных возможностей Докувики, устанавливаются плагины расширяющие синтаксис и возможности оформления.

Немного о копирайтах

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

Если вы начали и не окончили какую-то статью, или просто создали промежуточную вводную страницу, чтобы разместить на ней конкретную ссылку, то пометьте в начале такую неоконченную статью значком 'FIXME' FIXME. Можете также добавть пару слов о чем статья предполагаеться.

Энциклопедический характер статей

Если это ваши собственные статьи, а не вы выкладываете копию чужой, то постарайтесь придерживаться объективности. Статья должна иметь энциклопедический характер. То есть не надо выражать свое мнение, не надо писать что хорошо, а что плохо, что вам нравиться, а что нет. Старайтесь просто описывать факты. Люди пусть сами для себя решают как им относиться к тому или иному факту, и применять или нет какието приемы.

Вы можете указать в статье ссылки на материалы использованные при работе над статьей, но ссылки эти должны быть не коммерческими. То есть, если вы в статье о девайсе, в качестве описания даете ссылку на материал, выложенный в интернет-магазине, скорее всего такая ссылка будет удалена или заменена ссылкой на сайт производителя, если таковой имееться.

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

Оформление статей

С монитора читать однозначно тяжелее, это свойственно как для глаз, так и специфика интернет, на знакомство со страницей или фактом люди подсознательно тратят определенное время. Если у вас не мего-интересная статья, то рекомендуеться ее разбивать на части или абзацы. В идеале части должны быть озаглавлены. Постарайтесь делать так чтобы такой блок полностью занимал не более 3/4 экрана при разрешении 1024х768.

Во первых по этим заголовкам автоматически строиться содержание, которое вы видите справа вверху. По нему сразу можно судить какие вопросы освещены в статье. В содержание попадают заголовки H1, H2 и H3, и если их не менее 3 штук на статью.

Во вторых эти же первых три вида заголовка позволяют в дальнейшем работать с озаглавленными блоками отдельно, ибо для них появляеться отдельная кнопочка «Править». Также их можно будет включать в состав других статей. Пример на этой же странице, блок 'Теги' в разделе 'Ссылки', включен со страницы extend_syntax.

В третьих это позволит выглядеть статьям однотипно, заголовок статьи делаеться первого уровня (кнопка H1). Далее по мере вложенности. Не обязательно следовать порядку вложенности, если много мелких абзацев или определений, то может идти сразу много заголовков пятого уровня.

Абзацы не делаються с помощью '\\'. Абзац это разделение строк промежутком больше чем стандартный межстрочный интервал. Создается он двойным переводом строки (двойное нажатие Ентер).

Определения. К сожалению в синтаксисе докувики не предусмотрено такое понятие как словарь или определение и его раскрытие, потому здесь тоже лучше всего пользоваться заголовком пятого уровня, а определение понятия делать простым текстом. (Это исправлено, определения добавлены и их синтаксис описан в extend_syntax)

Используйте списки. Вообще списки рекомендуеться использовать повсеместно. Они хорошо структурируют информацию, и представляют информацию более компактно.

Как вы видите это все сделано с помощью заголовков и списков.

Заметьте насколько решение со списками выглядит компактнее

 
===== Пример описания настроечных переменных =====

== cl_crosshair_size  ==
Определяет размер прицела

Допустимые значения:
  * small - маленький
  * medium - средний
  * large - большой
  * auto - динамический

== cl_crosshair_color  ==
  * Определяет цвет прицела. Если цвет черный и прозрачность прицела включена, то прицел будет невидим.
  * Значение заключаеться в кавычки и состоит из тройки RGB значений 
    * "0 0 0" - черный прицел
    * "255 255 255" - белый прицел
    * "255 0 0" - красный прицел

== cl_crosshair_translucent ==
  * Включение прозрачности прицела

Пример описания настроечных переменных

cl_crosshair_size

Определяет размер прицела

Допустимые значения:

  • small - маленький
  • medium - средний
  • large - большой
  • auto - динамический
cl_crosshair_color
  • Определяет цвет прицела. Если цвет черный и прозрачность прицела включена, то прицел будет невидим.
  • Значение заключаеться в кавычки и состоит из тройки RGB значений
    • «0 0 0» - черный прицел
    • «255 255 255» - белый прицел
    • «255 0 0» - красный прицел
cl_crosshair_translucent
  • Включение прозрачности прицела

Картинки и логотипы.

Уменьшенное лого CSНашел где-то полную коллекцию логотипов стим игр от вальве, вы их можете увидать в медиа-библиотеке в каталоге :images:valve_logo. Файлы .png имеют размер 256х256. Фон у них прозрачный, поэтому можно вставлять где угодно.

Также в медиа-библиотеке, в каталоге :images:misc будут находиться всякие полезные картинки, которые можно использовать в своих статьях. При добавлении туда картинок, постарайтесь давать им осмысленные имена.

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

Размер вы читали надеюсь как изменяеться: {{:images:valve_logo:desert_storm.png?32|вертолетик}} - выглядит вот таквертолетик. При этом уменьшенная картинка автоматически становиться ссылкой на оригинал.

То что идет после '|' будет показано при наведении мышки на картинку. Пользуйтесь описаниями. Они также будут показаны, если просмотр картинок в браузере отключен.

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

Ссылки

Изучайте нашу энциклопедию, вы должны в ней хорошо ориентироваться, используйте внутренние ресурсы и материалы. Не дублируйте статьи, делайте внутренние ссылки. К примеру все названия что используються в контре будут даны в глоссарии.

Создавайте ссылки на статьи которые по вашему мнению должны быть написаны. Если к примеру статья о настройке управления то дайте ссылку на статью об акселерации мышки, или разгоне USB порта. Даже если такой статьи нет она может быть написана позже вами или другим автором.

К сожалению русские названия не воспринимаються, поэтому называйте страницы правильно по английски. Не транскрипцией, а именно переводом понятия. То есть не 'mishi' или 'miwi', а 'mouses'.

Также если какоето понятие лучше осветить отдельно или оно требует пояснения, дайте на него ссылку из википедии. Если понятие касаеться непосредственно CS или чего то совсем близкого, статью из википедии можно перенести к нам. Переписать, укоротить, или наоборот расширить (зачастую в википедию нюансы и детали не попадают, да и не нужны они там).

И обязательно используйте теги:

Теги

Теги - это слова которые вставляються в заголовок страницы и предназначены для поиска и улучшенного индексирования страницы поисковыми системами. Также дают возможность отбирать страницы по этим тегам.

Синтаксис таков:

{{tag>[список тегов]}}

к примеру в статье про razer DA:

{{tag>мышка razer 3G DeathAdder}}
Внизу этой страницы справа, можно увидеть теги этой страницы.

В дальненйшем можно построить список статей содержащих к примеру тег 'синтаксис':

Использование тегов:

Еще о синтаксисе:
{{topic>синтаксис}}

И будут показаны все статьи содержащие этот тег.

Еще о синтаксисе:

Расширения 2009/03/05 18:05 Zefir
Рекомендации для пишущих и исправляющих 2009/02/28 00:36 Zefir
Синтаксис форматирования    
· 2009/03/05 18:05 · Zefir

Структура нашей энциклопедии

Энциклопедия предназначена в первую очередь для игроков, хотя возможно более обширные материалы будут для админов :) Но всеже игрок на первом месте. Поэтому дополнительно пространства имен для игрока не предусмотрено. Все основные статьи выкладывайте прямо в корень нашей вики. Дополнительные материалы располагайте в подходящем разделе. Всегда просмотреть существующее дерево можно по кнопочке внизу справа «все страницы».

Статьи для админов будут находиться в разделе admin, статьи о девайсах в разделе devices. Вводная статья раздела может или лежать уровнем выше, и называться также как раздел, или ее нужно называть start, devices:start к примеру.

Interwiki

Ссылки на википедию организовываються с помощью так называемого interwiki. Я надеюсь вы уже прочти в статье syntax о них. Вот список всех интервики которые есть у нас. Если нужно будет еще какието говорите, дополню. Рекомендую пользоваться wpru для русской части википедии:

# You can add more InterWiki shortcuts here.

wp        http://en.wikipedia.org/wiki/{NAME}
wpru      http://ru.wikipedia.org/wiki/{NAME}
wpde      http://de.wikipedia.org/wiki/{NAME}
cerb      http://cerberus.cstrike.in.ua/wiki/{NAME}
cerbru    http://cerberus.cstrike.in.ua/wiki/ru:{NAME}
amx       http://wiki.alliedmods.net/{NAME}
amxru     http://wiki.alliedmods.net/Ru:{NAME}
wpmeta    http://meta.wikipedia.org/wiki/{NAME}
schoki    http://www.schokilade.de/doku.php?id=
doku      http://www.dokuwiki.org/
steam     http://supportwiki.steampowered.com/wiki/
steamru   http://supportwiki.steampowered.com/ru/
freecache http://freecache.org/{NAME}
rfc       http://www.cs.ccu.edu.tw/~chm91u/rfc2html.php?in=
sb        http://www.splitbrain.org/go/
amazon    http://www.amazon.com/exec/obidos/ASIN/
amazon.de http://www.amazon.de/exec/obidos/ASIN/{URL}/ballermannsyndic/
amazon.uk http://www.amazon.co.uk/exec/obidos/ASIN/
google.de http://www.google.de/search?q=
man       http://man.cx/
phpfn     http://www.php.net/{NAME}
go        http://www.google.com/search?q={URL}&btnI=lucky
dokubug   http://bugs.splitbrain.org/index.php?do=details&task_id=
coral     http://{HOST}.{PORT}.nyud.net:8090/{PATH}?{QUERY}

Также поддерживаються все стандартные со страницы http://usemod.com/intermap.txt

Дискуссия

ZefirZefir, 2009/03/04 12:29

Обсуждения

То что обсуждения для статей будут полезны, это однозначно. Но первый вопрос который стоит обсудить, это вопрос включить ли обсуждение для всех страниц или нет?.

Обсуждение на странице включить или выключить, или закрыть легко. Тут стоит вопрос в том, какое количество страниц будет иметь обсуждения. Понятно что большинство статей по девайсам должны быть обсуждаемые. Ну а другие?

Если я включу обсуждение для всех, то вам нужно будет на тех страницах которые обсуждению не подлежат, (даже не знаю таких кроме главной) обсуждение отключать так:

~~DISCUSSION:off~~

Если наоборот, обсуждения выключены, то вам на каждой статье о мышке или коврике, его надо будет включить так:

~~DISCUSSION~~

Если обсуждение переросло в флуд, то его можно закрыть:

~~DISCUSSION:closed~~

Добавьте просто одну из этих строк в конец вашей статьи.

ZefirZefir, 2009/03/05 08:45

Хо, добавил интересную вещь, теперь мона вставлять вот такие напоминалки или заметки:

<note>Просто заметка</note>

Просто заметка

<note important>Очень важная заметка</note>

Очень важная заметка

<note tip>Подсказка</note>

Подсказка

<note warning>Осторожно, не забывайте, это важно</note>

Осторожно, не забывайте, это важно

BoJIkBoJIk, 2009/03/05 10:53

Зефирчик дорогой это все великолепно и супер но не особо то и надо…. давайте сосеродоточимся на качественном контенте а не на картинках и т д ….

ZefirZefir, 2009/03/05 10:57

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

А контент, то да, надо добавлять и править. И что более важно народ привлекать.

Введите ваш комментарий (доступен синтаксис wiki):
If you can't read the letters on the image, download this .wav file to get them read to you.

 
wiki/for_authors.txt · Последние изменения: 2009/04/30 18:12 От zefir
 
За исключением случаев, когда указано иное, содержимое этой вики предоставляется на условиях следующей лицензии:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki


Linux coutner EOMY TOP 100Game's TOP-100 Counter