Help:Форматирование

From Wiki4Intranet
Revision as of 19:27, 3 July 2015 by PavelTrushin (Talk) (Включение других статей)

Jump to: navigation, search

Редактировать вики-страницу очень просто. Щёлкните на ссылку Править, чтобы изменить содержание страницы. На странице правки есть текстовая форма с исходным размеченным текстом страницы.

Далее:

  1. введите желаемые изменения;
  2. напишите краткое описание сделанных изменений в соответствующей строке;
  3. нажмите [Показать предварительный вариант] для проверки внесённых изменений на возможные ошибки;
  4. нажмите [Записать страницу].

Часто бывает удобно предварительно скопировать текст в текстовый редактор(через буфер обмена), редактировать и проверить на ошибки в нём, а затем скопировать текст в браузер.

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

Ещё вы можете обсуждать статьи с сотрудниками. Для этого используйте ссылку Обсуждение. Обсуждение проходит тоже в формате WikiWiki. Для каждой статьи в Wiki4Intranet может существовать параллельная страница с её обсуждением — это сделано для того, чтобы разделить

  • достигнутый набор фактов и договоренностей в статье,
  • а собственно набор неурегулированных вопросов с мнениями сторон — в обсуждении.

Малозначимые изменения

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

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

Вики-разметка

Ниже приведена справочная таблица по редактированию в Wiki4Intranet. Прежде, чем применять эти «инструменты» на «живом теле» Wiki4Intranet, поэкспериментируйте, пожалуйста, сначала в «песочнице».


Как это выглядит Что следует набрать

Полужирное и курсивное начертания используются в следующих случаях:

логическое ударение
структурное выделение
логическое ударение в структурном выделении

Это двойные и тройные апострофы, а не кавычки.

''логическое ударение''<br>
'''структурное выделение'''<br>
'''''логическое ударение в структурном выделении'''''.

Вы также можете писать курсивом и жирным, если вас интересует определенный стиль шрифта, а не логическое выделение, например, в математических формулах:

F = ma

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

Вы также можете писать ''курсивом'' и '''жирным''',
если вас интересует определенный стиль шрифта,
а не логическое выделение, например,
в математических формулах:

:'''F''' = ''m'''''a'''
Вы можете вставлять специальные символы См. WikiHelp:Специальные символы

Сложные формулы:
  

  
<m>\sum_{n=0}^\infty \frac{x^n}{n!}</m>

Подавление интерпретации разметки:
Link → (''to'') the [[{{SITENAME}}:Справка]]

  • Используется для изображения данных, содержащих символы со специальным значением.
  • Игнорирует всю разметку wiki, включая ту, что выглядит как теги HTML.
  • Не игнорирует символьные последовательности HTML.
<nowiki>Link &rarr; (''to'')
the [[{{SITENAME}}:Справка]]</nowiki>
Как это выглядит Что нужно набрать

Начните раздел со строки заголовка:

Новый раздел

Подраздел

Под-подраздел

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


== Новый раздел ==

=== Подраздел ===

==== Под-подраздел ====

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

Но пустая строка начинает новый абзац.

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

Но пустая строка
начинает новый абзац.

Сделать список очень просто:

  • каждая строка начинается со звездочки;
    • чем больше звездочек — тем глубже уровень.
Сделать список очень просто:
* каждая строка начинается со звездочки;
** чем больше звездочек — тем глубже уровень.
  1. Нумерованные списки тоже хороши:
    1. очень организованные;
    2. лёгкие для восприятия;
      и с вставкой абзацев
    3. без прерывания нумерации.
# Нумерованные списки тоже хороши:
## очень организованные;
## лёгкие для восприятия;
##: и с вставкой абзацев
## без прерывания нумерации.

Можно также делать

  • смешанные списки:
    1. и вкладывать их
      • как например:
Можно также делать
*смешанные списки:
*# и вкладывать их
*#* как например:
Список определений 
список определений
пункт 
определение пункта
; Список определений : список определений
; пункт : определение пункта
Двоеточие делает отступ строки или абзаца.

Ручной перенос строки начинает новый абзац.

  • Это применяется в основном для отображаемого материала, но также используется для обсуждения на Страницах обсуждения.
: Двоеточие делает отступ строки или абзаца.
Ручной перенос строки начинает новый абзац.
ЕСЛИ строка начинается с пробела ТОГДА
  она будет отформатирована так же,  
    как и набрана;
  шрифтом с фиксированной шириной;
  без переноса строк;
КОНЕЦЕСЛИ
Это можно применять для:
  * вставки преформатированного текста;
  * описания алгоритмов;
  * исходного кода программ
  * ascii art.

ВНИМАНИЕ! Если вы сделаете такую строку длинной, вы сделаете всю страницу широкой и из-за этого менее читабельной. Никогда не начинайте обычные строки с пробела.

 ЕСЛИ строка начинается с пробела ТОГДА
   она будет отформатирована так же,
     как и набрана;
   шрифтом с фиксированной шириной;
   без переноса строк;
 КОНЕЦЕСЛИ
Это можно применять для:
  * вставки преформатированного текста;
  * описания алгоритмов;
  * исходного кода программ
  * ascii art;
Горизонтальная разделительная линия: вверху

и внизу.

Горизонтальная разделительная линия: вверху
----
и внизу.
Сноска [1] будет у тэга references.
  1. Это сноска.
Сноска <ref>Это сноска.</ref> будет у тэга references.

<references/>

Ссылки, URL


Как это выглядит Что надо набрать

Мы работаем в проекте КИС Спортмастер.

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

Таким образом, приведенная выше ссылка ведет на http://penguin.office.custis.ru/wiki/index.php/КИС_Спортмастер, которая является статьей с названием «КИС Спортмастер».


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

Пример: Мы собираемся вести обсуждение системы управления версиями "CVS".

Мы работаем в проекте [[КИС Спортмастер]].
Мы собираемся вести обсуждение [[CVS|системы управления версиями "CVS"]].
Та же ссылка, но с другим именем: справочная информация.
Та же ссылка, но с другим именем:
[[wikipedia FAQ|answers]]
Окончания сливаются со ссылкой: использование CVSа.
Окончания сливаются со ссылкой: использование [[CVS]]а.
Можно ссылаться на подраздел в самой статье, указав его после «решётки»: Использование флагов в Bugzilla.
Можно ссылаться на подраздел в самой статье,
указав его после «решётки»:

[[Bugzilla#Флаги|Использование флагов в Bugzilla]].

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

#REDIRECT [[CVS]]
Внешняя ссылка: Nupedia
внешняя ссылка:
[http://www.nupedia.com Nupedia]
Или просто укажите URL: http://www.nupedia.com.
  • В URL все символы должны находиться в диапазонах: A-Z a-z 0-9 ._\/~%-+&#?!=()@ \x80-\xFF. Если URL содержит другие символы, их следует преобразовать: например, ^ следует записывать как %5E (чтобы можно было просматривать в ASCII).
Или просто укажите URL:
http://www.nupedia.com.

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

Sound

Image of a Tornado



[[media:Sg_mrob.ogg|Sound]]

[[media:Tornado.jpg|Image of a Tornado]]


Рисование графов

Можно очень легко рисовать графы по текстовому описанию. Читайте описание Graphviz!

Изображения


Таблицы

HTML-разметка

Можно также свободно использовать HTML-разметку. Например:

Как это выглядит Что нужно набрать

Разделы, которые не попадают в Содержание

Новый раздел

Подраздел

Под-подраздел


<h2> Новый раздел </h2>
<h3> Подраздел </h3>
<h4> Под-подраздел </h4>

Можно разрывать строки
не начиная новый абзац.
Можно разрывать строки<br>
не начиная новый абзац.
Центрированный текст.
<center>Центрированный текст.</center>
Моноширинный шрифт для технических терминов.
Моноширинный шрифт для  <tt>технических терминов</tt>.
Вы можете использовать маленький текст для заголовков.
Вы можете использовать <small>маленький текст</small> для заголовков.
Вы можете перечеркивать удаленный материал

и подчеркивать новый материал.

Вы можете <strike>перечеркивать удаленный материал</strike>
и <u>подчеркивать новый материал</u>.
x2   ≥   0 true

Для разделения пробелами используйте знак пробела: &nbsp;. Это также предотвращает переносы строк посреди текста, что полезно в формулах.

''x''<sup>2</sup>&nbsp;&nbsp;&ge;&nbsp;&nbsp;0 true.
Нижний индекс: x2

Верхний индекс: x2 или x²

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

ε0 = 8.85 × 10−12

C² / J m.
Нижний индекс: x<sub>2</sub>
Верхний индекс: x<sup>2</sup> or x&sup2;
&epsilon;<sub>0</sub> =
8.85 &times; 10<sup>&minus;12</sup>
C&sup2; / J m.

Комментарий в исходном тексте страницы:
не отображается на странице

Используется для внесения в исходный текст страницы комментария для последующих редакторов.

<!-- комментарий -->

Но вообще, злоупотребление HTML-ем нежелательно, т.к. засорение текста структурными элементами-тегами сильно уменьшает читаемость исходного текста.

Включение других статей

Иногда есть желание включить в статью содержимое другой статьи. Это возможно как частный случай механизма шаблонов: указав в теле статьи

{{:Название статьи}}

мы полностью включим статью «Название статьи» в нашу.

Если мы хотим включить статью как отдельный раздел нашей, то необходимо перед включением сделать подраздел, а внутри включаемой статьи указать <enableheadshift> - тогда заголовки во включаемой статье будут сдвинуты на нужное количество уровней.

Подробнее о механизме шаблонов смотри в WikiHelp:Шаблоны

Можно включать также не всю статью, а только выбранный подраздел

{{:Название статьи#Подраздел}}

Как вернуть предыдущее состояние статьи?


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


Статья реплицируется в Wiki4IntraNet.

Внимание! Данная статья выбрана для репликации в SMWiki.