Викиучебник:Как править Викиучебник

Песочница • Новичкам • Правила • Справка • Форум • Сообщество

Викиучебник, как и Википедия, работает по принципу «вики», и на том же программном движке — MediaWiki. Поэтому научиться пользоваться Викиучебником можно из справочных страниц Википедии, в особенности:

• Как использовать Викиучебник
• Как править статьи
• Как и зачем регистрироваться

Есть ещё пошаговый викиучебник, пригодный в качестве методического пособия: «Вики».

Также смотрите эссе на тему Как принять участие в проекте и Список правил и руководств.

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

Как читать

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

Гипертекст

Викиучебники составляются как гипертексты, а не простые (последовательные, «книжные») тексты. Поэтому, в частности, мы не поясняем прямо тут, что такое «гипертекст», а просто ставим в предыдущем предложении гиперссылку на статью Википедии.

Ссылки

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

• Ссылка на статью «Ботва» в Википедии
• Ссылка на список ссылок на эту страницу («Справка»)
• Ссылка на входную страницу Викиучебника, оформленная как общесетевой URL
• Ссылка на несуществующую страницу

Что помещать

Если неочевидна пригодность вносимого текста для Викиучебника, автору следует озадачиться вопросами:

• Полезно ли знание, предлагаемое текстом, в действительной жизни?
• Что мешает назвать это учебником?
  • Можно ли от этого избавиться без переработки текста, а лишь добавив нечто?
  • Можно ли убрать «мешающие» части?
• Вообразимо ли, что этот текст был бы выпущен печатным тиражом и распродан в книжных магазинах?
• Если нет, то чем он отличается в лучшую сторону от печатных учебников? Может быть, он мог бы быть издан и распродан в виде CD-DVD диска?

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

Как начать

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

• Решите о заглавии.
• Задумайте подходяющую структуру учебного текста и продумайте, как она будет представлена на сайте.
• Если требуются, поищите соавторов и ценителей среди других посетителей сайта.
• Научитесь работать в вики-среде (из Справки в Википедии или из Викиучебника «Вики») поработайте сперва над существующими текстами (по ходу получая из них знания), поучитесь правильным и изящным способам оформления, наладьте себе эффективный набор инструментов для удобства редактирования.
• Подумайте, как украсить Ваш текст.

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

Как начнёте новый учебник, запишите его на страницу Учебники и укажите ступень его развития (как у других, пиктограммой). Можете найти соответствующую статью в Википедии и поставить на свой учебник ссылку с помощью шаблона {{Викиучебник}}.

Не уповайте

Думаете, почему у нас много заготовок учебников? Многие начинают их с расчётом, что по появлении одной-двух еле законченных глав со всех концов Рунета тотчас прибегут трудолюбивые соавторы и сделают всю работу по замыслу начинателя.

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

Структурирование

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

Помещение одной страницей

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

#Заголовок подраздела

Это будет работать со внутренними [[вики-ссылками]]. А для внешней ссылки адрес можно получить из вышеупомянутого списка содержания (иначе не сработает, ибо в URL-строке русские буквы должны кодироваться %D0%92%D0%BE%D1%82 так).

Контекстные гиперссылки

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

Если же автор хочет увести внимание читателя на другую страницу, он может просто поставить гиперссылку на неё. Например, если Вы ещё не знаете, как делать гиперссылки, можете перейти к странице Википедия: Как править статьи в Википедии. А ещё можете прочесть самоописание Викиучебника.

Сноски

Сноски — это такие гиперссылки, ссылающиеся на верхнюю контекстную гиперссылку. Для того, чтобы сделать сноску следует просто ввести:

<references />

Объединяющее именование

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

• Уход за питомцами: Кормление
• Уход за питомцами — Купание

Такие способы применять не стоит, ибо есть другой, при котором автоматически создаётся гиперссылка на раздел «уровнем выше»:

• Уход за питомцами/Прогулка

На странице с таким названием будет автоматически стоять гиперссылка на страницу «Уход за питомцами», с которой, в свою очередь, можно ссылаться на подразделы сокращённым способом:

[[/Прогулка]]

приведёт читателя на страницу Уход за питомцами/Прогулка.

Или так

[[/Прогулка/]]

тоже приведёт читателя на страницу Уход за питомцами/Прогулка, но без указания названия основного учебника в ссылке.

Вспомогательные ссылки

Бывает полезно поместить заметную и наглядную ссылку на связанную страницу обособленно от текста, например: «К оглавлению», «Следующая глава: (Заголовок)», "Углублённые темы: " и тому подобные. Можно применять стрелочки ←→↑↓ и другие спецсимволы. Можно оформлять HTML’ом и CSS’ом, при умении.

Меню

Легко создать меню для викиучебника, то есть меню в интернетном смысле: список гиперссылок на подразделы сайта, а в нашем случае — на страницы данного викиучебника.

1. Создаёте особую страницу с приставкой "Шаблон: ". (Пример: Шаблон:ОФП Содержание.)
2. Сделайте на ней меню. Оформьте его красиво и удобно.
3. В любом месте, где надо поместить это меню, сделайте вызов шаблона, вот так: {{ОФП Содержание}}. Приставка "Шаблон: " опускается.

Не беспокойтесь о ссылках на текущую страницу: таковые всегда будут выделены и «отключены» в качестве гиперссылок. Пример: Викиучебник:Справка.

Категории

Любая страница может быть помещена в категории, которые также могут быть вложены.

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

Такой способ обеспечивает построение оглавления учебника и даёт возможность создания нескольких аспектов структуры учебника, например, содавать оглавления «для начинающих» — «для быстрого ознакомления»; «по видам блюд» — «по ингредиентам» — «по национальным кухням»; «в алфавитном порядке» — «по темам» — «по сложности» и так далее. Недостаток у этого пути разве только в том, читатель может проглядеть список категорий данной страницы.

Так составлена Кулинарная книга.

Также смотрите Викиучебник:Категоризация.

Включение страниц

Всё содержимое страницы можно включить в другую, вот так:

{{:Название включаемой страницы}}

(Увы, древеса категорий так не включаются.) Так можно, например, делать одностраничные версии подразделённых учебников или отдельных глав, — пригодится для создания печатных версий учебников.

Именование

Именовать страницы и подразделы страниц следует по разумным правилам, указанным далее в порядке предпочтения.

Правила русского языка и типографики

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

Заглавие:
Неправильное	Правильное
Слово «алгоритм» — Происхождение и развитие	Слово «алгоритм»: происхождение и развитие

Соображения удобства и красоты

В вики-среде удобство заглавия страницы определяется, в первую очередь, его краткостью: чем короче оно, тем легче поставить на данный документ как вики-ссылку с другой страницы, так и общесетевую URL-ссылку. Ещё один аспект удобства — удобочитаемость; краткость названия при этом — также положительный фактор, но есть и другие: следует избегать неакронимных сокращений («И. П. Сидоров и др.» и т. п.), чередования языков и алфавитов, неоднозначных и малоизвестных слов.

Красота звучания и написания названия имеет объективную меру. Не забывайте о ней, всё же предпочитая правильность и удобство.

Нелепое	Человечное
Руководство по работе со звуком в GNU/Linux	Звук в GNU/Linux или Звук в Линуксе

Соответствие сути

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

Лукавое	Верное
Курс информатики для школьников 8—9 классов	Информационные технологии

Понятность

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

• Загадочно-масонское: LOR-FAQ
• Не понимаете? И не надо : Suomen kieli käyttöön
• Жаргон : Свойства оператора свёртки
• «Названия не переводятся» : Ruby, Microsoft Excel
• …но иногда всё же поясняются: Язык программирования D
• Заголовки журнальных статей : Знакомство с методом математической индукции
• Понятное, хоть и неформальное, название: Математика случая
• Заглавие, хотевшее стать оглавлением: Защита конфиденциальных данных и анонимность в интернете

Перенаправления

Обязательно ставьте перенаправления со всех распространённых альтернативных или ошибочных вариантов названия на правильный.

Вёрстка

Можно и нужно использовать возможности украшения текста. Это когда наглядно различается обычный повествовательный текст, строки кода, математические переменные (например $x$ или $\Omega$),

• обычные списки и

списки

определений,

эпиграфы оформляются как эпиграфы,

иногда с указанием автора, места и времени;

важное выделяется жирностью, кеглем и стилем шрифта или посредством CSS.

Набор вспомогательных шаблонов[1] сбережёт время на создании часто применяемых элементов оформления.

• ^  — Список всех шаблонов можно найти на служебной странице «Allpages»

Вот пример:

---

Значок пользователя ЖЖ fhtagn или сообщества ru_obrazovanie

Если надо вывести что-то без обработки вики-разметки, используйте метку <nowiki></nowiki>, например <nowiki>{{Внимание|[[w:Еда|]]}}</nowiki> выдаст {{Внимание|[[w:Еда|]]}}, а не как обычно.

Подсветка программного кода

Общий синтаксис выглядит так:

• <source lang=""></source>

<source lang="тут_пишите_название_языка_программирования">
здесь_пишите_сам_программный_код_на_языке,_который_Вы_ввели_ранее
</source>

Для вывода слова «Мир» в Ruby следует ввести следующие: <source lang="ruby">times{print "Мир!"}</source> превращается в:

times{print "Мир!"}

• Код подсвечивается с помощью расширения mw:Extension:SyntaxHighlight GeSHi, которое добавляет тег <source lang=""></source> и альтернативный тег <syntaxhighlight lang=""></syntaxhighlight> (в случае если в подсвечиваемом коде (например, XML) содержится тег <source>, который нужно подсветить, а не обработать). Примеры параметров.

Настройка вывода, копирование и печать

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

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

1. Настройте в своём браузере шрифт с засечками и такого кегля, чтобы обычный текст сравнялся по величине с формулами.
2. В настройках печати уберите весь дополнительный служебный текст (разве только номер страницы можно оставить) и излишне широкие поля.
3. Там же настройте масштаб страницы. Если на странице есть изображения (некоторые формулы также выводятся картинками), то масштабировать следует с оглядкой на искажения картинок.
   • Желательно масштабировать с таким шагом: 25 %, 50 %, 100 %, 200 %
4. Желательно сохранить все элементы оформления страницы (цвета/фон/изображения/стиль) неизменными.
5. Проверьте, показан/спрятан ли как надо блок «содержание» в начале книги
6. Перейдите к версии страницы для печати и проверьте (в браузере), как он будет смотреться на бумаге.
7. Проверьте, достаточно ли бумаги в принтере и по желанию настройте двустороннюю печать (как в книге).

Работа с текстом

Увеличение размера текста

Увеличить текст очень просто. Для этого нам нужно использовать тег <big>. Чтобы увеличить размер текста, выполните пошагово инструкцию:

1. В начале фрагмента текста, который Вы хотите сделать крупным, поставьте тег (просто напишите): <big>
2. В конце фрагмента текста, который Вы хотите сделать крупным, поставьте тег (просто напишите): </big>

Если бы мы увеличивали текст «Текст», то результат бы был таким:

Текст

Жирный текст

Для установки жирного текста его следует взять с одной и с другой стороны в тройные кавычки, как показано ниже:

'''Жирный текст'''

Результат будет таким:

Жирный текст

Курсивный текст

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

''Жирный текст''

Результат будет таким:

Жирный текст

Другие методы работы с текстом

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

Раскрашивание текста

Для того, чтобы текст приобрёл какой-то цвет, следует сделать три шага:

1. Написать в начале отрывка текста, который Вы хотите форматировать: <span style="color:цвет">
2. А в конце текста, который Вы хотите форматировать, написать: </span>
3. После этого заменить слово «цвет» на любой цвет из этого списка:
   1. green
   2. blue
   3. gold
   4. yellow
   5. red
   6. purple
   7. black
   8. gray

Результат будет таким:

1. green: Здесь раскрашенный текст.
2. blue: Здесь раскрашенный текст.
3. gold: Здесь раскрашенный текст.
4. yellow: Здесь раскрашенный текст.
5. red: Здесь раскрашенный текст.
6. purple: Здесь раскрашенный текст.
7. black: Здесь раскрашенный текст.
8. gray: Здесь раскрашенный текст.

Раскрашенные URL-ссылки

Раскрашивать URL-ссылки на другие вики-страницы просто. Для этого сначала следует:

1. Написать [[ .
2. После чего ввести название вики-страницы, на которую будет поставлена ссылка.
3. Далее ввести | .
4. После чего просто раскрасить текст, как показано выше.
5. Ввести ]]

Общий синтаксис раскрашенной URL-ссылки выглядит так:[[название_вики_страницы|<span style="color:цвет_текста_ссылки">Здесь раскрашенный текст.</span>]] Например, если мы хотим сделать ссылку на страницу «Справка» зеленым цветом, то код ссылки будет выглядеть так:

[[Справка|<span style="color:green">Открыть справка.</span>]]

Результат будут таким:

Открыть справка.

Работа с изображениями

Свободные изображения, используемые для оформления текстов в Викиучебнике необходимо загружать не в него непосредственно (хотя тут такая функция есть), а в братский проект - Викисклад. После этого загруженное изображение можно использовать не только в русскоязычном разделе Викиучебника, но и в любом проекте или языковом разделе. Для вставки в текст загруженного изображения используйте штатную конструкцию [[Файл:Gliderlogbook-Lak.jpg]] или [[File:Gliderlogbook-Lak.jpg]] . Если у вас сложности с формированием такой конструкции для своего изображения, воспользуетесь кодом который предлагает Мастер загрузки на последнем шаге.

Работа с документами PDF

Свободные документы, например, акты органов власти Российской Федерации, находящиеся в формате PDF, который в свою очередь представляет набор растровых изображений (результат сканирования бумажного оригинала обычно), надо загружать в Викисклад. Если имеет смысл, то текст этого документа параллельно размещать в Викитеке. Пример такого размещения.

Пример конструкции для вставки документа в текст: [[File:Название файла на Викискладе.pdf|thumb|Подпись к документу]].

Ссылка на текст в Викитеке формируется таким образом: перед именем статьи в Викитеке надо добавить "s:" [[s:Письмо_руководителя_ФАВТ_от_18.05.2011_№АН1.02-1813|Письмо руководителя ФАВТ]].

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

Работа с таблицами

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

Таблица не такая уж и сложная вещь. Её надо только понять.

Создание первой таблицы

Сначала найдите и откройте вики-страницу «Песочница».

Чтобы знать как таблицы выглядят в Викиучебнике нажмите на кнопку «где нарисована табличка». Но перед этим зайдите в режим редактирования песочницы. Для этого нажмите кнопку «править» над текстом «песочницы». После нажатия кнопку «где нарисована табличка» появится сообщение о выборе типа таблицы и выборе количества строк и столбцов. Тип таблицы бывает сортируемый и не сортируемый. Первый тип таблиц позволяет сортировать таблицу. Например, в таблице у нас есть имена Вася, Петя, Данил, Ангел. При обратной сортировке таблицы получится: Ангел, Данил, Петя, Вася. Количество строк и столбцов установить просто. Для этого введите в форму значения нужное количество строк и столбцов. И ещё есть такая функция таблицы как «оформление границами». Это очень удобно, когда строки и столбцы чётко разделены, а таблицу так легче читать.

Создание первых шаблонов и их использование

Перед созданием шаблона убедитесь в том, что тема создаваемого шаблона не будет совпадать с темами существующих шаблонов.

Для создания шаблона проделайте следующие шаги:

1. Введите в форму «Поиск» текст: «Шаблон:».
2. После чего напишите название будущего шаблона (на русском языке) (не обязательно, есть шаблоны с английскими названиями, например {{BookCat}}).
3. Должно получиться так: «Шаблон:Название».
4. Нажмите на кнопку перейти.
5. Введите текст (код) шаблона.
6. Шаблон готов!!!

Для его использования на страницах Викиучебника следует писать такую конструкцию:

{{Название_шаблона}}

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

Гиперсссылки

Гиперссылка на разделы страницы оформляется так: [[#название_раздела_страницы]]

Выражения (Expressions)

EXPR expression

{{#expr: числовое выражение}}

Вычисляет значение выражения.

Возможные ошибки в примерах:

{{#expr: 1 + }} Встречено '}}', а ожидалось число.

{{#expr: + }} Встречено '+', а ожидалось число.

{{#expr: 1 прибавить }} Встречено 'прибавить', а ожидалась операция.

IFEQ expression

{{#ifeq: сравнимое значение 1|сравнимое значение 2| equal|not equal}}

Выводит на экран equal при равенстве выражений иначе not equal.

Специальные слова движка «MediaWiki»

Help:Magic_words/ru

Для скрытия оглавления:

{{__NOTOC__}}

---

Для вывода числа статей в Викиучебнике следует употребить конструкцию:

{{NUMBEROFARTICLES}}

---

Для скрытия ссылок «править»:

{{__NOEDITSECTION__}}

---

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

{{__NOINDEX__}}

---

Для отображения текущего года:

{{CURRENTYEAR}}

---

Для отображения месяца последней правки:

{{REVISIONMONTH}}

---

Для отображения числа всех страниц в Викиучебнике:

{{NUMBERFORPAGES}}

---

Для отображения числа всех правок в Викиучебнике:

{{NUMBERFOREDITS}}

---

Для отображения числа всех участников в Викиучебнике:

{{NUMBERFORUSERS}}

См. также

Справка на MediaWiki.