Справка:Справка по редактированию

Материал из AlexNook
Перейти к: навигация, поиск

Создание страниц

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

Что такое категория

Категория это просто деление на группы какого-то множества. Допустим нам надо всё живое на земле разделить на категории. Можно выделить растения, животных, насекомых, микробов ну и т.д. То есть тут мы просто разносим по смысловым группам элементы множества.

Неймспейс (NameSpace)

Это пространство имён. Это понятие знаком всем программистам. Для всех остальных в картце раскажу. Допустим у нас есть 2 семьи которые живут в одном доме. Номер дома можно задать как отдельной категорией. У нас будет допустим много домов (какой-то воображаемый район города). Так вот эти 2 семьи живут в одном доме и находятся в одной категории.

Мы хотим сделать перечень членов семьи по именам данных семей. Категория у нас уже есть - это номер дома, но как быть если в первой сеьме живёт мальчик Саша а во второй семье живёт тоже мальчик Саша? То есть у нас идёт коллизия имён - несостыковка. В категории ДОМ №n у нас полчается 2 мальчика с одинаковыми именами. Как их различить?

Для этого вводят пространство имён. То есть у нас есть пространство имён семьи Ивановых и семьи Петровых. Получается, что у нас имена не перепутаются. Тогда для обращения к Саше мы можем чётко указать какой из двух Саш нам нужен. То есть мы имеем такой вариант - Категория ДОМ №n Неймспейс Иванов. И таким образом мы чётко выделили Сашу Иванова.

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

Как создать страницу?

Допустим мы хотим создать страницу о коровах в категории животные в неймспейсе млекопитающие. Для этого пишем строке адреса вашего браузера http://donik.org/wiki/Mammals:Cows. Откроется новая страница на которой нам будет сказано то, что данной странице ещё нет и её можно создать, нажав на ссыку. Нажимаем на ссылку и создаём страницупро коров. После этого в самом низу странице добавляем следующую строчку [[Category:animals]]. Всё - наша задача выполнена =)

Для опытных

При создании страницу можно отнести к нескольким категориям. Для этого добавляем внизу страницы столько категорий, сколько нам нужно. [[Category:Cat1]], [[Category:Cat2]], [[Category:Cat3]] и т.д.

Если вернуться про пример о коровах, то может наступить ситуация, когда нам надо создать статью о корове с кличкой Бурёнка. Для этого в адресной строке браузера надо прописать http://donik.org/wiki/Mammals:Cows/Бурёнка. То есть мы выделяем подстраницу Бурёнка у которой родительская страница будет о коровах и которая будет находится в неймспейсе млекопитающие. Затем для порядка эту страницу можно тоже занести в нужную нам категорию.

Редактирование уже созданных страниц

Кнопка подписи

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

В некоторых случая написанный вами материал важно подписать, оставив свой автограф, для чего используйте либо символ --~~~~ либо специальную кнопку на панели инструментов окна редактирования (см. рисунок). Так же помните, что если вы вносите незначительные изменения (например правка орфографии или стиля отображения данных, то есть смысл поставить галочку Малое изменение рядом с кнопкой Записать страницу.

Шаблоны

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

Заливка и вставка картинок

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

[[Изображение:PicNameInWiki.png|thumb|left|Подпись под картинкой]]

После чего продолжаем писать страницу. Когда закончили жмём записать страницу. Затем нажимаем на красную ссылку отсутствующей картинки и нам откроется меню заливки файла. Следует различать имя картинки на вики и на вашем локальном компьютере, то есь при заливки не будет иметь значения какое имя было у файла у вас на компе - влияние будет оказывать только имя в вики - PicNameInWiki.png.

Параметр thumb означает сделать превьюшку картинки.

Далее идёт параметр выравнивания - в данном случае left. Если его упустить то по умолчанию будет выравнено по правому краю. Например [[Изображение:PicNameInWiki.png|thumb|Подпись под картинкой]]. Так же можно указать выравнивание по центру - center.

Затем идёт текст подписи под картинкой.

Важно отметить, что в таком варианте вставки картинок они будут иметь плавающее свойство и будут выравниваться по верху родительского блочного элемента и будут обтекаться равномерно текстом. Для создания пропусков между картинкой и текстом делаем обычные переводы строк. Либо
из XHTML либо просто двойной перевод строки (2 раза по enter =) нажать).

Подсветка синтаксиса

Для подсветки синтаксиса была установлена одна из наиболее мощных систем Geshi. Почитать о ней можно, например, вот тут. Для краткости просто приведу пример её исплоьзования.

<syntaxhighlight lang="php" line start="100" highlight="18" line="GESHI_FANCY_LINE_NUMBERS" enclose="div">
<?php
class ModuleNews extends Module
{
	public function init()
	{
		$this->document = new DocumentX($this->name);
		$this->document->custom_xslt = true;
	}
	
	/**
	 * Выводим список новостей
	 * @param $arg->page->value принимает номер страницы
	 */
	
	public function ActionBrowsenews(ActionArgs $arg)
	{
		// мы должны были получить номер страницы...
		if ( !isset($arg->page->value)) $arg->page = new Argument(1, Argument::integer);
		// селекты...
		$db=Application::$db;
		// ...
	}
}
?>
</syntaxhighlight>

Например, код выше выведет на страницу, следующую информацию:

  1. <?php
  2. class ModuleNews extends Module
  3. {
  4.         public function init()
  5.         {
  6.                 $this->document = new DocumentX($this->name);
  7.                 $this->document->custom_xslt = true;
  8.         }
  9.        
  10.         /**
  11.          * Выводим список новостей
  12.          * @param $arg->page->value принимает номер страницы
  13.          */
  14.        
  15.         public function ActionBrowsenews(ActionArgs $arg)
  16.         {
  17.                 // мы должны были получить номер страницы...
  18.                 if ( !isset($arg->page->value)) $arg->page = new Argument(1, Argument::integer);
  19.                 // селекты...
  20.                 $db=Application::$db;
  21.                 // ...
  22.         }
  23. }
  24. ?>

Вставка формул и выражений

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

Как пример введите код

{{#ifexpr: 1 > 0 | yes }}

Он выдаст после сохранения страницы - yes


Для вставки сложных математических формул и выражений установлена поддержка TeX. Как пример можете написать такой вот код:

<math>\pi=\frac{3}{4} \sqrt{3}+24 \int_0^{1/4}{\sqrt{x-x^2}dx}</math>

<math>\text{cost}= \text{base} 
\times 2^{\text{level}-1}</math>

Он выдаст вам следующее

\pi=\frac{3}{4} \sqrt{3}+24 \int_0^{1/4}{\sqrt{x-x^2}dx}

\text{cost}= \text{base} 
\times 2^{\text{level}-1}

Для более подробной информации можете почитать книжку о LaTeX (есть отличный вариант - называется Не очень краткое введение в LaTeX или LaTeX за 94 минуты) или посмотреть вот тут или тут за парой простейших примеров.

Заливка файлов

Для заливки файлов использовать можно тот же принцип что и при заливки картинок. Только в текст уже вставляется код вида

[[Медиа:WikiFileName.doc|Скачайте]] меня!

Как пример я вставил файл вордовского документа. При этом файл имеет имят в на сайте WikiFileName.doc, а ссылка, отображаемая на сайте и ведущая к скачке файла имеет вид Скачайте. То есть мы дописываем текст страницы до конца и потом уже записав страницу мы загружаем файл.

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

Так же можно заливать файлы и на бесплатные файлообменные ресурсы, но тут важно помнить, что эти файлы как правило оочень трудно скачать с них из-за трёх основных ограничений: 1) Скорость, 2)Время ожидания скачки и 3) Невозможности скачивать несколько файлов одновременно. А ещё эти файлы лежат там как правило месяц может три, а потом удаляются, что не очень удобно и хорошо для нас.

Некоторые фичи

Тут опишу наиболее часто используемые при написании статей фичи (features).

Как отменить вики разметку

Для отмены вики разметки в тексте нужно текст занести в тег: <nowiki>Текст</nowiki>

Перенос строки

Для этого либо надо вставить 2 переноса строки (клавиша Enter) либо тег

Строка 1

Строка 2
Строка 1
<br/>
Строка 2

Результат будет один:

Строка 1
Строка 2


Создание списка

Для создания обычного спискап пишем:

* Строка 1
* Строка 2
* Строка 3
** Подстрока 3.1
** Подстрока 3.2
* Строка 4

В итоге получаем

  • Строка 1
  • Строка 2
  • Строка 3
    • Подстрока 3.1
    • Подстрока 3.2
  • Строка 4

Для нумерованного списка принцип тот же:

# Строка 1
# Строка 2
# Строка 3
## Подстрока 3.1
## Подстрока 3.2
# Строка 4
  1. Строка 1
  2. Строка 2
  3. Строка 3
    1. Подстрока 3.1
    2. Подстрока 3.2
  4. Строка 4

Создание отступа

Для отступа в начале строки надо вставить двоеточие:

: маленький отступ
:: Больше отступ
::: И т.д.
маленький отступ
Больше отступ
И т.д.

Выделение в рамку

Для выделения в рамку надо текст занести в код:

<pre>

Текст

Строка номер 2

Строка номер 3

</pre>

То есть использовать тег <pre></pre>

Текст
Строка номер 2
Строка номер 3