Xgu.ru:Справка

Материал из Xgu.ru

(Перенаправлено с Справка:Содержание)
Перейти к: навигация, поиск

На Xgu.ru используется движок MediaWiki. Это значит, что при написании статей можно использовать разметку такую же как, например, в Wikipedia или других проектах, базирующихся на mediawiki.

Содержание

[править] Рекомендации по использованию

[править] Сокращённый URL

Сокращённый URL для wiki-страниц:

http://xgu.ru/=Страница

То есть, вместо wiki/ в адресе можно писать просто символ =.

Например, вместо адреса

http://xgu.ru/wiki/Xen

можно использовать адрес

http://xgu.ru/=Xen

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

[править] Песочница

Экспериментировать можно на странице-песочнице:

[править] Summary, краткое описание правки

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

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

В описании правки вы можете использовать традиционную wiki-разметку.

Размер поля расширен с традиционных 250 до 2500, так что разгуляться есть где.

[править] Дополнительные шаблоны

{{Скрытый|Нажмите на слово справа, чтобы развернуть|Развёрнутый текст, который интересен не всем. И показывается он тоже не всем, а только тем, кто хочет его увидеть.}}


Тогда нужно использования названия параметров (title и content): {{Скрытый|Нажмите на слово справа, чтобы развернуть|content= Много текста на разных строках. * Картинки могут быть, * списки, * блоки кода. }}

[править] Заголовки и подзаголовки

Заголовок верхнего уровня отмечается двумя символами ==, слева и справа от заголовка. Для заголовков более низкого уровня количество знаков = увеличивается. Например:

== Заголовок ==
=== Подзаголовок ===

[править] Ссылки

Xgu.ru используется в том числе как склад ссылок. Плохо, когда склад превращается в свалку. Пользы от этой свалки уже никакой нет, найти что-то с помощью google намного быстрее. Удалять такие свалки тоже рука не поднимается, и тепловая смерть вселенной приближается.

Чтобы её немного отдалить:

  1. Если вы добавляете ссылку, добавьте краткое описание того, куда она ведёт.
  2. Если вы видите свалку ссылок, поставьте шаблон {{cleanup-links}}.
  3. Лучше всегда ставить ссылку в виде примечания к тексту, к которому она относится, чем выносить её в блок "Дополнительная информация".
  4. Не забывайте указывать язык той страницы, на которую ведёт ссылка {{ru}}, {{en}}, {{de}}, или ссылки на специальные проекты (см. ниже).
  5. Для ссылок внутри Xgu.ru используйте [[Название]], а не пишите [http://xgu.ru/wiki/Название Название]. Если видите такую ссылку, исправьте её, пожалуйста, если вам не очень сложно.
  6. Если вы просто встретили какую-то хорошую ссылку, но вам лень с ней возиться, запишите её на страницу обсуждения. И даже тут пара слов о том, что же там такого хорошего, не помешает.

Шаблон cleanup-links выглядит так:

Cleanup.png

Нужно подчистить ссылки

Специальные проекты известные на Xgu.ru:

  • Stackoverflow.png — {{so}} — StackOverflow
  • Github.png — {{gh}} — GitHub
  • Bitbucket-logo.png — {{bb}} — BitBucket
  • Quora-icon.png — {{q}} — Quora
  • Habrahabr.png — {{habr}} — Habrahabr
  • Youtube.jpeg — {{yt}} — YouTube

[править] Недописанные куски

Если вы чувствуете, что в каком-то месте на странице надо было бы подробнее написать о чём-то, но сейчас у вас не доходят до этого руки, не оставляйте это просто так — поставьте пометку, чтобы потом не забыть.

Пометки ставить можно с помощью шаблона todo-here:

  
   {{todo-here|text=
     Написать подробнее о том, как можно расширять возможности командного
     интерпретатора bash с помощью загружаемых модулей.
   }}

Выглядит это так:

Эти темы не раскрыты: Подробнее о том, как можно расширять возможности командного интерпретатора bash с помощью загружаемых модулей.

Если статья ещё в совсем сыром состоянии, используйте шаблон stub в её начале, чтобы читатель был готов к тому, что он сейчас увидит.

Если статья в целом готова, но в ней не хватает каких-то мелочей, с помощью шаблонов todo-here, укажите, какие это вещи, и убирайте шаблон stub.

[править] Язык

Статьи на xgu.ru пишутся на русском языке (за исключением случаев, когда статья написана на каком-то другом языке намеренно, в этом случае язык статьи указывается в аннотации к ней), без использования ненормативной лексики и с минимумом жаргонизмов (например: локальная сеть, вместо локалка; удалять вместо выпиливать; добавлять вместо запиливать).

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

Если соответствующего устоявшегося термина в русском языке нет, можно транскрибировать оригинальный термин и записать исходный в скобках сразу за ним. Для транскрипции лучше всего использовать стандартные правила, принятые в русском языке (см.,например, §74 Транскрипция иностранных слов Розенталя [1]).

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

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

Например, вместо:

  • я копирую файл из /a/ в /b/

лучше использовать:

  • файл копируется из /a/ в /b/

или, если вся страница написана в императиве:

  • скопируйте файл из /a/ в /b/

Желательно, чтобы текст оставался простым и был понятен не только автору (или хотя бы как минимум ему). Не надо повторяться. Слова должны нести смысловую нагрузку. Использование хитрых художественных приёмов допускается, но лучше не злоупотреблять ими.

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

Хорошие рекомендации по тому, как писать тексты:

Страницы, язык которых сильно отличается от принятого на xgu.ru, отмечаются шаблоном cleanup-lang.

В параметре text шаблона можно указать, на что нужно обратить внимание при переработке текста.


  
   {{cleanup-lang|text=
     * орфография
     * стиль
   }}

Выглядит это так:

Icon-cleanup-lang.jpg

Язык статьи отличается от языка, принятого на xgu.ru.
Вы можете улучшить статью, приведя текст статьи к принятым у нас нормам.

На что обратить внимание:

  • орфография
  • стиль

[править] Вопросы и ответы

[править] По какому принципу выбираются темы на Xgu.ru? Похоже, что вы здесь пишете про всё подряд

Так и есть. Автор сам выбирает тему, которая ему интересна, и работает над ней.

При выборе учитывается множество факторов, в числе которых и потенциальный интерес читателей к теме. Если вы считаете, что рассмотрению какой-то темы стоило бы уделить внимание, вы можете указать её на странице Xgu.ru:todo или поддержать тему, если её предожили раньше.

[править] Я заметил опечатку. Что мне делать?

Если не лень, можете исправить.

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

[править] На другом wiki-сайте есть классная статья по той же теме, что и здесь. Как проставить интервики?

Допишите в конец соответствующей статьи на Xgu.ru:

[[код:название]]

Здесь:

  • код — обозначение сайта, на который делается интервики.
  • название — название статьи на том сайте.

Поддерживаются интервики на сайты (если вы считаете, что нужно добавить поддержку интервики ещё для какого-то сайта, напишите об этом, пожалуйста, на странице обсуждения):

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

[[enwp:Python]]
[[dewp:Python]]
[[ruwp:Python]]
[[ukwp:Python]]

[править] Как в тексте сделать ссылку на другой wiki-сайт?

Так же, как и указано выше, только добавив двоеточие вначале, т.е:

[[:код:название]]

например:

[[:ruwp:Python]]

Если нужной wiki нет в списке выше, то делаем обычную ссылку:

[http://ru.wikipedia.org/wiki/Python Python]

[править] Дополнительная информация