Последние изменения - Поиск:

Разделы

PmWiki

ред.

Основы Разметки

PmWiki.BasicEditing История

Показать незначительные изменения - Показать разницу в результате

09.05.2009 13:13 изменил tch -
Изменены строки 1-26 с
(:Summary: PmWiki's basic edit syntax:)
(:Audience: authors (basic) :)

The pages on this site are [[Wiki Wiki Web]] pages, which means that pages can be created and edited by multiple authors. To edit a page, click the '''Edit''' link that exists '''somewhere''' on the page, usually in the header or footer. Some pages may be [[password(s)]]-protected, depending on the system's security policies, but many systems allow open editing of pages.

PmWiki is not [[(Wikipedia:)WYSIWYG]] - When editing a page, you see the ''markup text'' that describes the content of the page. The basic rules for page markup are simple:
# Use a blank line to start a new paragraph [-[[#Paragraphs|more]]-].
# To make a list, start each line with # for numbered (ordered) lists or * for bulleted (unordered) lists [-[[#lists|more]]-].
# To make a heading, start a line with two or more ! marks; !! is a subheading, and !!! is a sub-subheading [-[[#headings|more]]-].
# To emphasize text, enclose it in 2 or 3 ''single quotes''; [@''text''@] for italics or [@'''text'''@] for bold [-[[#emphasis|more]]-].
# To make a link to another page, enclose the page's name in double brackets; for example [@[[basic editing]]@] links to this page [-[[#links|more]]-].
# To make a link to another site, type its address, such as http://example.com/ [- [[#links|more]]-].

'''If you want to experiment with editing a page, try it on the [[Main/Wiki Sandbox]].''' You can [[Main/WikiSandbox?action=edit | edit the Wiki Sandbox]] without affecting anything important on this site. If you do edit other pages, it's courteous to '''sign''' your contribution; using [=~~=]~ effectively 'signs' the name that you provide in the Author field on the Page Edit form.

!! Examples of common markups

The table below demonstrates many of the common markups used to format pages. The right column shows the effect of the markup, the left column shows what to write to achieve the effect. More details are available from the [[text formatting rules]] and other documentation pages. An exhaustive list of default markup is available as the [[markup master index]].

!!! [[#Paragraphs]]Paragraphs and line breaks

(:table class='markup horiz' align='center':)
(:cellnr class='markup1':)
[-'''What to type'''-]
(:cell class='markup2':)
[-'''What it looks like'''-]
на:
(:title Основные правила разметки:)
Страницы на этом сайте -- это [[WikiWikiWeb]] страницы. Это означает, что они могут быть созданы и изменены несколькими авторами. И вы тоже можете стать соавтором нажав на ссылку '''$[Edit]''', часто расположеную где-то на заголовке или в конце страницы. Часто не все страницы открыты для свободного изменения. Некоторые особо важные могут быть защищены паролем.

Во время редактирования вы видите "текст разметки", который описывает содержимое страницы. Основные правила разметки страницы очень просты:
# %rframe width=15pct% [--Lingvo переводит "bulleted list" как "список ''(текст)'' с буллитами". ужас!--]%% Для разделения параграфов используется пустая строка;
# Для разметки нумерованых списков начинайте строки с символа '#'[-(диез)-], а для маркированых списков -- с символа '*'([-звезда-]); Подсписки начинаются с '##', '###'... или '**', '***'.. и т.д;
# Строки заголовков начинаются с '!'; Подзаголовков с '!!'; Подподзаголовков с '!!!';
# Выделеный курсивом текст заключают между ''двойными одиночными кавычками'' [@''text''@], а для жирного '''тройными''' -- [@'''text'''@];
# Для ссылки на другую страницу её имя окружают двойными квадратными скобками; Например [@[[Basic Editing]]@] укажет на эту страницу; Ссылки на [[несозданные страницы]] так, чтобы попросить её создать;
# Для ссылки на другой сайт просто наберите его адресс: http://www.yandex.ru ;

'''Если вам захочется поэкспериментировать с редактированием странички, то [[Main/WikiSandbox]] как раз для этого.''' [[Main/WikiSandbox?action=edit | Изменение WikiSandbox]] ничего не испортит. Однако, когда вы что-то правите на других страницах, то будет правильно '''подписатся''' под своими исправлениями. "[=~~=]~" автоматически заменяется на ваше имя, указаное в поле "Author" на странице редактирования.

!! Примеры

В таблице даётся много распространённых способов разметки используемых для форматирования страниц. В левой колонке показан результат, а в правой -- что надо написать для его получения. Подробнее читайте [[text formatting rules|+]] и другую документацию. На странице [[markup master index|+]] имеется '''исчерпывающий список''' способов разметки.

!!! Общее применение

(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
%center% '''Как выглядит'''
(:cell:)
%center% '''Как сделано'''
(:cellnr:)
Простой ''перевод'' строки
не разбивает абзац.
Но ''(к несчастью)
изменяет'' разметку.
(:cell:) [@
Простой ''перевод'' строки
не разбивает абзац.
Но ''(к несчастью)
изменяет'' разметку.
@]
(:cellnr:)
Автор должен

использовать пустую строку для начала
нового параграфа. А для переноса\\
строки -- две обратные дробные черты.
(:cell:) [@
Автор должен

использовать пустую строку для начала
нового параграфа. А для переноса\\
строки -- две обратные дробные черты.
@]
(:cellnr:)
* Списки делаются используя звёздочки
** Больше звёздочек -- дальше отступ
*** Список заканчивается
первой строкой не из списка

# Нумерованые списки
# также возможны
** как и смешаные
(:cell:) [@
* Списки делаются используя звёздочки
** Больше звёздочек -- дальше отступ
*** Список заканчивается
первой строкой не из списка

# Нумерованые списки
# также возможны
** как и смешаные@]
(:cellnr:)
* Обратная дробная черта в \
конце строки присоединяет \
следующую строку и '''сохраняет \
разметку'''.
* Две обратные дробные черты\\
создают перенос в параграфе.
* Три такие черты делают\\\
два переноса.
(:cell:) [@
* Обратная дробная черта в \
конце строки присоединяет \
следующую строку и '''сохраняет \
разметку'''.
* Две обратные дробные черты\\
создают перенос в параграфе.
* Три такие черты делают\\\
два переноса.
@]
(:cellnr:)
-> Стрелка ([@->@]) включает отступ

Для продолжения отступа выравнивайте текст

--> Более длинные стрелки ([@-->@]) дают \
больший отступ

-<Обратная стрелка ([@-<@]) делает \
первую строку подвешанной \
относительно остальных строк \
абзаца.
--< Также, длиннее обратная стрела ([@--<@]) \
больше отступ тела параграфа.
(:cell:) [@
-> Стрелка (->) включает отступ

Для продолжения отступа выравнивайте текст

--> Более длинные стрелки (-->) дают \
больший отступ

-<Обратная стрелка (-<) делает \
первую строку подвешанной \
относительно остальных строк \
абзаца.
--< Также, длиннее обратная стрела (--<) \
больше отступ тела параграфа.
@]
(:cellnr:)
: Определения : список определений
: элемент : определение элемента
: другой элемент : ещё определение
(:cell:) [@
: Определения : список определений
: элемент : определение элемента
: другой элемент : ещё определение
@]
(:cellnr:)
Строки начинающиеся
с пробела выводятся
моноширинным шрифтом.

[-Отметьте, что очень длинные строки такого \
текста могут увеличить ширину всей страницы.-]
(:cell:) [@
Строки начинающиеся
с пробела выводятся
моноширинным шрифтом.
@]
(:cellnr:)
%center% Этот текст отцентрован.

%right% А этот прижат вправо.
(:cell:) [@
%center% Этот текст отцентрован.

%right% А этот прижат вправо.
@]
(:cellnr:)
Четыре или больше минусов
в начале строки
----
образуют горизонтальное отчёркивание.
(:cell:) [@
Четыре или больше минусов
в начале строки
----
образуют горизотальное отчёркивание.
@]
Изменены строки 158-216 с
(:markup class=horiz:)
Consecutive lines
will be merged together
as part of the same paragraph.

One or more empty lines will start a new paragraph.
(:markupend:)

(:markup class=horiz:)
Two backslashes at the end of a line \\
force a line break.

Or use this markup: [[<<]] to force a break.
(:markupend:)
Further reading:
* [[text formatting rules]] for more information on linebreaks, indented or hanging paragraphs.
* [[wiki styles]] for centered or right justified paragraphs and "floating" text (boxes), borders and much more.

!!![[#lists]]Lists
Start each line with # for numbered (ordered) lists or * for bulleted (unordered) lists:
(:markup class=horiz:)
* Bullet list
* Another item
** More asterisks produce sub-items
** etc.
(:markupend:)

(:markup class=horiz:)
# Numbered lists
# Another item
## more hashes produce sub-items
(:markupend:)

(:markup class=horiz:)
# List types
# can be mixed
** numbered list with unordered sub-list
(:markupend:)

(:if false:)
if someone thinks definition lists are "basic":
(:markup class=horiz:)
: Definition list : list of definitions
: item : the item's definition
: another item : that item's definition
:: indentation : more leading colons produce deeper lists
(:markupend:)
(:ifend:)

Learn more about [[TextFormattingRules#BulletedLists|lists]] (including [[TextFormattingRules#DefinitionLists|definition lists]]) and [[list styles]].

!!![[#headings]] Headings
Headings are useful for creating a "well-structured" page. They're not just for making big text.

(:table class='markup horiz' align='center':)
(:cellnr class='markup1':)
[-'''What to type'''-]
(:cell class='markup2':)
[-'''What it looks like'''-]
на:

!!! [[#links]] [[Links | Ссылки]]

(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
%center% '''Как выглядит'''
(:cell:)
%center% '''Как сделано'''
(:cellnr:)
Практика редактирования
в [[Main/wiki sandbox]].

* Текст в двойных прямоугольных скобках образует \
ссылку на другие страницы.
* В заголовках слова ссылок автоматом делаются \
с большой буквы.
(:cell:) [@
Практика редактирования
в [[Main/wiki sandbox]].
@]
(:cellnr:)
Практика редактирования
в [[Main/WikiSandbox]].

Которая?
О, в [[Main.WikiSandbox]].

* Когда ссылаетесь на страницу в другой викигруппе, указывайте имя группы перед дробной чертой.
* Если разделителем служит дробная черта, то видно только имя страницы.
* Если разделитель точка, то будет ссылка будет видна целиком.
(:cell:) [@
Практика редактирования
в [[Main/WikiSandbox]].

Которая?
О, в [[Main.WikiSandbox]].
@]
(:cellnr:)
Практика редактирования на
[[WikiSandbox | тренировочной площадке]].

Практика редактирования на
[[Main.WikiSandbox | тренировочной площадке]].

Практика редактирования на
[[тренировочной площадке -> WikiSandbox]].

* Текст после палки (|) становится текстом ссылки; его ещё можно задать по другому (возможно так понятнее): перед стрелкой (текст [@->@] ссылка).
(:cell:) [@
Практика редактирования на
[[WikiSandbox | тренировочной площадке]].

Практика редактирования на
[[Main.WikiSandbox | тренировочной площадке]].

Практика редактирования на
[[тренировочной площадке -> WikiSandbox]].
@]
(:cellnr:)
Практика редактирования на
[[wiki sandbox]]es.

Практика редактирования на
[[(wiki) sandbox]].

* Окончание становится частью текста ссылки, но не адреса.
* Скобки скрывают часть имени ссылки.
(:cell:) [@
Практика редактирования на
[[wiki sandbox]]es.

Практика редактирования на
[[(wiki) sandbox]].
@]
(:cellnr:)
Это [[(Wikipedia:)aardvark]], не так ли?

* Pmwiki поддерживает [[InterMap| InterMap префиксы]] которые имеют особое значение.
* В этом случае скобки так же прячут фрагменты адреса.
(:cell:) [@
Это [[(Wikipedia:)aardvark]], не так ли?
@]

(:cellnr:)
Ссылки на внешние ресурсы можно ввести так:
# просто путь: http://google.com
# с текстом: [[http://google.com | Google]]
# как сноска: [[http://google.com |#]]
(:cell:) [@
Ссылки на внешние ресурсы можно ввести так:
# просто путь: http://google.com
# с текстом: [[http://google.com | Google]]
# как сноска: [[http://google.com |#]]
@]

(:cellnr:)
Ссылки открывающиеся в новом окне
оформляются так: %newwin% http://www.pmwiki.org .
(:cell:) [@
Ссылки открывающиеся в новом окне
оформляются так: %newwin% http://www.pmwiki.org .
@]
Изменены строки 262-277 с
(:markup class=horiz:)
!! Major Subheading
!!! Minor Subheading
!!!! And More
!!!!! Subheadings
(:markupend:)

!!![[#emphasis]] Text Emphasis
To emphasize, enclose text in apostrophes (single-quote marks), not double-quotes.


(:table class='markup horiz' align='center':)
(:cellnr class='markup1':)
[-'''What to type'''-]
(:cell class='markup2':)
[-'''What it looks like'''-]
на:
!!! Строковое форматирование

(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
''Выделено'', '''сильнее''',
'''''особо сильно'''''.
(:cell:) [@
''Выделено'', '''сильнее''',
'''''особо сильно'''''.
@]
(:cellnr:)
@@Моноширинный текст@@

[@этот участок
предформатированый
текстовый блок@]
(:cell:) [@
@@Моноширинный текст@@ @]

[=
[@этот участок
предформатированый
текстовый блок@]=]
(:cellnr:)
* Индекс '^надстрочный^'
* Индекс '_подстрочный_'
* удалённый {-зачёркнутый-} текст
* вставленый {+подчёркнуты+} текст
* [+большой+], [++ещё больше++] текст
* [-мелкий-], [--ещё меньше--] текст
(:cell:) [@
* Индекс '^надстрочный^'
* Индекс '_подстрочный_'
* удалённый {-зачёркнутый-} текст
* вставленый {+подчёркнуты+} текст
* [+большой+], [++ещё больше++] текст
* [-мелкий-], [--ещё меньше--] текст
@]
(:cellnr:)
[[PmWiki.WikiStyles|Вики стили]] %red% позволяют
%blue% раскрашивать %green% текст
%color=#ff7f00% в разные %%цвета.

* Используйте символы нижнего регистра для задания RGB цветов (#ff7f00, а не [=#FF7F00=]).
(:cell:) [@
[[PmWiki.WikiStyles|Вики стили]] %red% позволяют
%blue% раскрашивать %green% текст
%color=#ff7f00% в разные %%цвета.
@]
Изменены строки 313-388 с
(:markup class=horiz:)
''Emphasize'' (italics),
'''strong''' (bold),
'''''very strong''''' (bold italics).
(:markupend:)

!!![[#links]] Links
To make a link to another page, enclose the page's name in double square brackets.

(:table class='markup horiz' align='center':)
(:cellnr class='markup1':)
[-'''What to type'''-]
(:cell class='markup2':)
[-'''What it looks like'''-]
(:tableend:)

(:markup class=horiz:)
Practice editing in the [[wiki sandbox]]
(:markupend:)
Note that words are automatically ''capitalized'' in page titles. The link above links to the page WikiSandbox.

Text after a pipe (|) is used as the link text:
(:markup class=horiz:)
Practice editing in the
[[WikiSandbox | practice area]].
(:markupend:)

(:comment is this still "basic" or should it be removed? :)
Endings become part of the link text, parentheses hide parts of the link name:
(:markup class=horiz:)
[[wiki sandbox]]es.

[[(wiki) sandbox]].
(:markupend:)

When linking to a page in a different [[WikiGroup]], provide the group name, followed by a separator, and then the page name:
(:markup class=horiz:)
[[Main.WikiSandbox]] shows group + name

[[Main/WikiSandbox]] shows only name
(:markupend:)

Links to external sites
(:markup class=horiz:)
bare url: http://google.com

link text: [[http://google.com | Google]]
(:markupend:)

Colons make [[InterMap]] (also called InterWiki) links to other wikis:
(:markup class=horiz:)
What's an [[Wikipedia:aardvark]], anyway?
(:markupend:)

Links to [[nonexistent pages]] are displayed specially, to invite others to create the page.

PmWiki supports more link types and a lot of display options, see [[Links]] to learn more.


!!!Preformatted text
Preformatted text is displayed using a monospace font and not generating linebreaks except where explicitly indicated in the markup.

Note that very long lines of preformatted text can cause the whole page to be wide.

For preformatted text with markup (e.g. emphasis) being processed, start each line with a space:
(:markup class=horiz:)
Lines that begin with a spece
are formatted exactly as typed
in a '''fixed-width''' font.
(:markupend:)

If you don't want Wiki markup to be processed, use [=[@ @]=]. Can also be used inline.
(:markup class=horiz:)
[@
Text escaped this way has
the HTML ''code'' style
на:
!!! Заглавия и блоки

(:table width='100%' border='1' cellspacing='0' cellpadding='2':)
(:cellnr width='40%':)
!! Старший Подзаголовок
!! [-Старший Подзаголовок Написаный Меньшим Шрифтом-]
!!! Младший Подзаголовок
!!!! И ещё
!!!!! Подзаголовок
* Заглавия нужны для подготовки "хорошо структурированых" страниц,
и это не просто строки крупным шрифтом.
(:cell:) [@
!! Старший Подзаголовок
!! [-Старший Подзаголовок Написаный Меньшим Шрифтом-]
!!! Младший Подзаголовок
!!!! И ещё
!!!!! Подзаголовок
Изменены строки 331-433 с
(:markupend:)

!!! Escape sequence
If you don't want Wiki markup to be processed, but lines reformatted use [@[= =]@]. Can also be used inline.
(:markup class=horiz:)
[=
markup is ''not'' processed
but lines are reformatted
=]
(:markupend:)


!!! Horizontal line
(:markup class=horiz:)
Four or more dashes at
the beginning of a line
----
produce a "horizontal rule"
(:markupend:)

!!! Tables
Simple tables use double pipe characters to separate cells:
(:markup class=horiz:)
|| border=1
||! head 1 ||! head 2 ||! head 3 ||
|| cell 1 || cell 2 || cell 3 ||
(:markupend:)
See [[Tables|simple tables]] and [[TableDirectives|advanced tables]] to learn more about the rich feature set of PmWiki tables.

!!! Images
See [[Images]]

(:if false:)
IMO this is not "basic" and should be removed from this page --OliverBetz
!!!Indented and "hanging" paragraphs
(:markup class=horiz:)
-> An arrow (->) indents content.

Line up text to continue the indent.

-->Longer arrows (-->) indent further.

-<A reverse arrow (-<) creates a hanging indent, the first line is outdented and remaining lines are indented.
(:markupend:)
(:ifend:)

!!! Character formatting

(:table class='markup horiz' align='center':)
(:cellnr class='markup1':)
[-'''What to type'''-]
(:cell class='markup2':)
[-'''What it looks like'''-]
(:tableend:)

(:markup class=horiz:)
* @@Monospaced text@@
* Text with '^superscripts^'
* Text with '_subscripts_'
* deleted {-strikethrough-} text
* inserted {+underline+} text
* [+big+], [++bigger++] text
* [-small-], [--smaller--] text
(:markupend:)

Use [[WikiStyles]] to change %red% the %blue% text %green% %color=#ff7f00% color %%.

[[#pagetitles]]
!!! Page titles

* The [@(:title:)@] directive sets the page's title to something other than its page name.
(:markup class=horiz:)
(:Title Basic PmWiki editing rules:)
The title of this page is {$Title}, spaced as {$Titlespaced}.
(:markupend:)

[[#pagesummary]]
!!! Page Description

* The [@(:Description Page summary here:)@] directive sets the page description. The description is used by search engines, and can displayed in search results and in [[page lists]].
(:markup class=horiz:)
(:Description PmWiki's basic edit syntax:)
The summary description of this page is {$Description}.
(:markupend:)



>>faq<< [[#faq]]
[[#beginning]]
Q: I'm new to PmWiki, where can I find some basic help for getting started?
A: The [[Basic Editing]] page is a good start. From there, you can just follow the navigational links at the bottom of the page (they are called [[Wiki Trails]]) to the next pages, or to the [[Documentation Index]] page, which provides an outline style index of essential documentation pages, organized from basic to advanced.

Q: How do I include special characters such as Copyright (&#169;) and Trademark (&#174; or &#8482;) on my wiki pages?
A: See [[special characters]] on how to insert special characters that don't appear on your keyboard.

Q: Why are separate lines of text in the markup combined into a single line on output?
A: PmWiki normally treats consecutive lines of text as being a paragraph, and merges and wraps lines together on output. This is consistent with most other wiki packages. An author can use the [@(:linebreaks:)@] directive to cause separate lines of markup text to be kept as separate lines in the output. A wiki administrator can set in config.php @@$HTMLPNewline = '<br/>';@@ to force literal new lines.

Q: Can I just enter HTML directly?
A: By default (and by design), PmWiki does not support the use of HTML elements in the editable markup for wiki pages. There are a number of reasons for this described in the [[PmWiki Philosophy]] and [[PmWiki:Audiences]]. Enabling HTML markup within wiki pages in a collaborative environment may exclude some potential authors from being able to edit pages, and pose a number of display and security issues. However, a site administrator can use the [[Cookbook:EnableHTML]] recipe to enable the use of HTML markup directly in pages.

Q: Where can I find more documentation?
A: See the [[DocumentationIndex | documentation index]] page.
на:
(:cellnr:)
-<'''Заголовок страницы'''
''не показан''
(:title Основы Разметки:)

* Директива [@(:title:)@] изменяет заголовок страницы на что-то отличное от её служебного имени.
(:cell:) [@
(:title Основы Разметки:)
@]
(:cellnr:)
-<'''Стили блоков'''
(:comment table и div здесь не работают:)
%block purple%Весь текст в этом блоке сиреневый.
* %item purple%Сиреневые коровы и сиреневые цветы
* %item purple%Сиреневые сливы вкуснее
* %item red% А теперь строка красная
* %item center% а эта отцентрована
* %item right% а эта выровнена вправо
* а это снова обычная
(:cell:) [@
>>purple<<
Весь текст в этом блоке
сиреневый.
* Сиреневые коровы и сиреневые цветы
* Сиреневые сливы вкуснее
>>red<<
* А теперь строка красная
>>center<<
* а эта отцентрована
>>right<<
* а эта выровнена вправо
>><<
* а это снова обычная@]
(:tableend:)
Править - История - Печать - Последние изменения - Поиск
Редакция от 09.05.2009 13:13