Викиучебник:Как править Викиучебник: различия между версиями

Содержимое удалено Содержимое добавлено
перенёс {{Shortcut|ВУ:С}} под шаблон {{Руководство}} и исправил первый абзац
викификация
Строка 13:
Википедийские [[w:Википедия:Правила и указания|рекомендации по стилю]] применительны и к Викиучебнику, но по мере их осмысленности в отношении учебных текстов: всё же в учебниках часто востребованы повествовательные приёмы, выходящие за границы научного стиля речи.
 
== Как читать ==
Мы надеемся, что Вы без подсказок поймёте, как работать с Викиучебником, по крайней мере, как продвигаться по его страницам и читать их. Если что-то непонятно, спрашивайте на [[Викиучебник:Общий форум|общем форуме]].
 
=== Гипертекст ===
Викиучебники составляются как [[w:гипертекст|гипертекстгипертексты]]ы, а не простые (последовательные, «книжные») тексты. Поэтому, в частности, мы не поясняем прямо тут, что такое «гипертекст», а просто ставим в предыдущем предложении гиперссылку на статью [[w:Википедия|Википедии]].
 
=== Ссылки ===
Но ссылки порой ведут не на статьи Википедии, а на другие страницы Викиучебника, или на иные сайты Всемирной сети. Разница указывается оформлением ссылок:
* [[w:Ботва|Ссылка на статью «Ботва» в Википедии]]
Строка 26:
* [[Несуществующая страница|Ссылка на несуществующую страницу]]
 
== Что помещать ==
Если неочевидна пригодность вносимого текста для Викиучебника, автору следует озадачиться вопросами:
* Полезно ли знание, предлагаемое текстом, в действительной жизни?
* Что мешает назвать это учебником?
** Можно ли от этого избавиться без переработки текста, а лишь добавив нечто?
** Можно ли убрать «мешающие» части?
* Вообразимо ли, что этот текст был бы выпущен печатным тиражом и распродан в книжных магазинах?
* Если нет, то чем он отличается в лучшую сторону от печатных учебников? Может быть, он мог бы быть издан и распродан в виде CD-DVD диска?
Если нет, то текст не подходит Викиучебнику. Однако, наверное, можно оставить его, если он пригодится в качестве подраздела или приложения к одному из существующих полноценных учебников.
 
== Как начать ==
Творить учебник трудно. Даже если Вы уверены в достатке знаний, способностей и энтузиазма для написания учебника и [[#Что помещать|его пригодности]] для сайта Викиучебник, сперва:
* Решите [[#Именование|о заглавии]].
* Задумайте подходяющую структуру учебного текста и продумайте, [[#Структурирование|как она будет представлена на сайте]].
* Если требуются, поищите соавторов и ценителей [[Планы и заявки|среди других посетителей сайта]] или инде.
* Научитесь работать в вики-среде (из [[w:Википедия:Справка|Справки в Википедии]] или из Викиучебника «[[Вики]]») поработайте сперва над существующими текстами (по ходу получая из них знания), поучитесь правильным и изящным [[#Вёрстка|способам оформления]], наладьте себе эффективный набор инструментов для удобства редактирования.
* Подумайте, как украсить Ваш текст.
 
После этого советуем сопоставить свои замыслы с существующими образцами готовых викиучебников: не повторяйте их ошибок и повторяйте их успехи. Если есть вопросы, задайте их в нашем [[форум]]е. Зарегистрируйтесь: это даст Вам обустроить внешний вид Викиучебника для удобной работы, присвоит Вашему имени все сделанные Вами правки и создаст личную страницу (где можно рассказать о себе) и страницу для личного обращения к Вам от других участников.
Строка 48:
<big>Как начнёте новый учебник, запишите его на страницу [[Учебники]]</big> и укажите ступень его развития (как у других, пиктограммой). Можете найти соответствующую статью в [[w:Википедия|Википедии]] и поставить на свой учебник ссылку с помощью шаблона <code>[[w:Шаблон:Викиучебник|<nowiki>{{</nowiki>Викиучебник<nowiki>}}</nowiki>]]</code>.
 
=== Не уповайте ===
Гадаете, почему у нас [[Учебники|так много покинутых недописок]]? Многие начинают их с расчётом, что по появлении одной-двух еле законченных глав со всех концов Рунета тотчас прибегут трудолюбивые соавторы и сделают всю работу по замыслу начинателя.
 
Не повторяйте их ошибку. Законченный, полезный текст будьте готовы написать самостоятельно. Конечно, можно оставить случайным редакторам огрехи правописания или вёрстку, но только если сам текст уже более-менее слажен и полезен.
 
== Структурирование ==
Упорядочивать сведения учебника и подразделять их надо разумно, радея об удобстве чтения и скорости создания [[w:вики|вики]]-текста.
 
=== Помещение одной страницей ===
Обычно — лучший способ с бесспорными достоинствами. Первое — удобство сохранения страницы на локальном компьютере и вывода на печать. Второе — автоматически создающийся, структурированный список всех подзаголовков, дающий удобные гипертекстовые ссылки на любой озаглавленный подраздел страницы.
При этом способе не теряется возможность ссылания на отдельные подразделы: нужно всего лишь после адреса ссылки поставить:
Строка 62:
Это будет работать со внутренними <nowiki>[[вики-ссылками]]</nowiki>. А для внешней ссылки адрес можно получить из вышеупомянутого списка содержания (иначе не сработает, ибо в URL-строке русские буквы должны кодироваться <code>%D0%92%D0%BE%D1%82</code> так).
 
=== Контекстные гиперссылки ===
Причиной деления книги на страницы может быть достаточная самостоятельность каждой страницы-главы, так что она полезна сама по себе вне контекста всего викиучебника.
 
Если же автор хочет увести внимание читателя на другую страницу, он может просто поставить гиперссылку на неё<ref>Если же нужно вместе со ссылкой дать пояснение, используйте [[w:Википедия:Сноски|сноски]] вместо внутритекстовых гиперссылок.</ref>. Например, если Вы ещё не знаете, как делать гиперссылки, можете перейти к странице [[w:Википедия:Как править статьи|Википедия: Как править статьи]] в Википедии. А ещё можете прочесть самоописание [[Викиучебник]]а.
 
==== Сноски ====
Сноски - это такие гиперссылки, ссылающиеся на верхнюю контекстную гиперссылку. Для того, чтобы сделать сноску следует просто ввести:
<code><nowiki><references /></nowiki></code>
<references />
 
=== Объединяющее именование ===
Можно именовать главы так, что читателю легко угадать название всего учебника, например:
* Уход за питомцами: Кормление
* Уход за питомцами - Купание
''Такие способы применять '''не стоит''''', ибо есть другой, при котором автоматически создаётся гиперссылка на раздел «уровнем выше»:
* Уход за питомцами/Прогулка
Строка 81:
; <code><nowiki>[[/Прогулка]]</nowiki></code>:приведёт читателя на страницу [[Уход за питомцами/Прогулка]].
 
=== Вспомогательные ссылки ===
Бывает полезно поместить заметную и наглядную ссылку на связанную страницу обособленно от текста, например: «К оглавлению», «Следующая глава: ''(Заголовок)''», «"Углублённые темы:» " и тому подобные. Можно применять стрелочки ←→↑↓ и другие [[w:Википедия:Специальные символы|спецсимволы]]. Можно оформлять [[w:HTML|HTML]]’ом и [[w:CSS|CSS]]’ом, при умении.
 
==== Меню ====
Легко создать меню для викиучебника, то есть меню в интернетном смысле: список гиперссылок на подразделы сайта, а в нашем случае — на страницы данного викиучебника.
# Создаёте особую страницу с приставкой '''«"Шаблон:» "'''. (Пример: [[Шаблон:ОФП Содержание]].)
# Сделайте на ней меню. Оформьте его красиво и удобно.
# В любом месте, где надо поместить это меню, сделайте вызов шаблона, вот так: <nowiki>{{ОФП Содержание}}</nowiki>. Приставка «"Шаблон:» " опускается.
Не беспокойтесь о ссылках на текущую страницу: таковые всегда будут '''выделены''' и «отключены» в качестве гиперссылок. Пример: [[Викиучебник:Справка]].
 
=== Категории ===
Любая страница может быть помещена в [[w:Википедия:Категории|категории]], которые также могут быть вложены.
 
Строка 100:
Так составлена [[Кулинарная книга]].
 
=== Включение страниц ===
Всё содержимое страницы можно включить в другую, вот так:
<code><nowiki>{{:Название включаемой страницы}}</nowiki></code>
(Увы, древеса категорий так не включаются.) Так можно, например, делать одностраничные версии подразделённых учебников или отдельных глав, — пригодится для создания печатных версий учебников.
 
== Именование ==
Именовать страницы и подразделы страниц следует по разумным правилам, указанным далее в порядке предпочтения.
 
=== Правила русского языка и типографики ===
Викиучебник стремится стать серьёзным образовательным изданием. Обязательно соблюдать правила русского языка и русской [[w:Типографика|типографики]]. В частности, не заменяйте в названиях букву [[w:Ё|ё]] иными.
 
Строка 117:
! style="width:50%;text-align:left;color:#060;"|Правильное
|-
| style="text-align:left"| Слово "«алгоритм"» - Происхождение и развитие
| style="text-align:left"| [[Слово «алгоритм»: происхождение и развитие]]
|}
 
=== Соображения удобства и красоты ===
В [[w:Вики|вики]]-среде удобство заглавия страницы определяется, в первую очередь, его краткостью: чем короче оно, тем легче поставить на данный документ как вики-ссылку с другой страницы, так и общесетевую [[w:URL|URL]]-ссылку. Ещё один аспект удобства — удобочитаемость; краткость названия при этом — также положительный фактор, но есть и другие: следует избегать неакронимных сокращений («И. П. Сидоров и др.» и т. п.), чередования языков и алфавитов, неоднозначных и малоизвестных слов.
 
Строка 131:
|-
| style="text-align:left"|Руководство по работе со звуком в GNU/Linux
| style="text-align:left"| [[Звук в GNU/Linux]]<br />или<br />[[Звук в Линуксе]]
|}
 
=== Соответствие сути ===
 
Название учебника должно определять его содержание; не быть частным, если повествует об общей теме, и наоборот; совсем уж нельзя ложно представлять суть учебного текста. Но, следуя этим соображениям, нельзя жертвовать краткостью и удобством заглавия страницы. Оно может быть верным, но не совершенно точным, и такое вполне допустимо.
Строка 146:
|}
 
=== Понятность ===
 
Заглавие может в краткой и удобной форме отражать содержание данной страницы, но не быть совершенно понятным. Понятность, и тем более понятность самому широкому кругу читателей — наименее важное, но всё же нужное качество заголовка.
 
* Загадочно-масонское: [[LOR-FAQ]]
* Не понимаете? И не надо : [[Suomen kieli käyttöön]]
* Жаргон : [[Свойства оператора свёртки]]
* «Названия не переводятся» : [[Ruby]], [[Microsoft Excel]]
* …но иногда всё же поясняются: [[Язык программирования D]]
* Заголовки журнальных статей : [[Знакомство с методом математической индукции]]
* Понятное, хоть и неформальное, название: [[Математика случая]]
* Заглавие, хотевшее стать оглавлением: [[Защита конфиденциальных данных и анонимность в интернете]]
 
=== Перенаправления ===
Обязательно ставьте [[w:Википедия:Перенаправления|перенаправления]] со всех распространённых альтернативных или ошибочных вариантов названия на правильный.
 
== Вёрстка ==
{{рамка}}Можно и нужно использовать возможности украшения текста. Это когда наглядно различается обычный повествовательный текст, <code>строки кода</code>, математические переменные (например <math>x</math> или <math>\Omega</math>),
* обычные списки и
;списки : определений,
{{Эпиграф|эпиграфы оформляются как эпиграфы,|иногда с указанием автора, места и времени;}}
Строка 170:
или <span style="color:brown;background:#f8fafc;border:thin dotted red;padding:0.3em;">посредством [[w:CSS|CSS]]</span>.
{{info|1=Набор вспомогательных ''шаблонов''{{Ref|shablony}} сбережёт время на создании часто применяемых элементов оформления.}}
* {{Note|shablony}} — Список всех шаблонов можно найти [http://ru.wikibooks.org/w/index.php?title=%D0%A1%D0%BB%D1%83%D0%B6%D0%B5%D0%B1%D0%BD%D0%B0%D1%8F%3AAllpages&from=&namespace=10 на служебной странице «Allpages»]
{{Внимание|'''Чрезмерная избыточность не нужна'''<br />
Не увлекайтесь шибко красочными значками и разноцветными рамками.}}
Строка 179:
Если надо вывести что-то без обработки вики-разметки, используйте метку <code><nowiki><nowiki></nowiki></nowiki></code>, например <code><nowiki><nowiki>{{Внимание|[[w:Еда|]]}}</nowiki></nowiki></code> выдаст <nowiki>{{Внимание|[[w:Еда|]]}}</nowiki>, а не как обычно.
 
=== Раскраска программного кода ===
Общий синтаксис выглядит так:
<nowiki><source lang="тут_пишите_название_языка_программирования">
Строка 208:
# В конце фрагмента текста, который Вы хотите сделать крупным, поставьте тег (просто напишите): <nowiki></big></nowiki>
Если бы мы увеличивали текст «Текст», то результат бы был таким:
: <big>Текст</big>
 
=== Жирный текст ===
 
Для установки жирного текста его следует взять с одной и с другой стороны в тройные кавычки, как показано ниже:
: <nowiki>'''Жирный текст'''</nowiki>
Результат будет таким:
: '''Жирный текст'''
 
=== Курсивный текст ===
 
Для изменения обского текста на курсивный следует взять текст, который Вы хотите изменить, в двойные кавычки:
: <nowiki>''Жирный текст''</nowiki>
Результат будет таким:
: ''Жирный текст''
 
== Работа с таблицами ==
До сих пор ваша информация в статьях была представлена в виде обычного или раскрашенного или увеличенного текста. Но читать информацию в таком формате не всегда удобно, например, если бы мы хотели написать о возможностях игровых движков, то писать текстом было бы не так уж и понятно для других пользователей. Нам потребовалось бы использовать таблицу.
 
Таблица не такая уж и сложная вещь. Её надо только понять.
 
=== Создание первой таблицы ===
::: ''Сначала найдите и откройте вики-страницу «Песочница».''
Чтобы знать как таблицы выглядят в Викиучебнике нажмите на кнопку «где нарисована табличка». Но перед этим зайдите в режим редактирования [[Викиучебник:Песочница|песочницы]]. Для этого нажмите кнопку «править» над текстом «песочницы». После нажатия кнопку «где нарисована табличка» появится сообщение о выборе типа таблицы и выборе количества строк и столбцов. Тип таблицы бывает сортируемый и не сортируемый. Первый тип таблиц позволяет сортировать таблицу. Например, в таблице у нас есть имена Вася, Петя, Данил, Ангел. При обратной сортировке таблицы получится: Ангел, Данил, Петя, Вася. Количество строк и столбцов установить просто. Для этого введите в форму значения нужное количество строк и столбцов. И ещё есть такая функция таблицы как «оформление границами». Это очень удобно, когда строки и столбцы чётко разделены, а таблицу так легче читать.
 
== Создание первых шаблонов и их использование ==
 
[[Категория:Викиучебник:Справка]]