About PukiWiki(English) FormatRule(English)



Это неоконченный перевод それは未完成の翻訳です

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

Элементы

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

Текст набранный таким образом

~Это параграф. Это родительский элемент содержащий выделенный текстовый элемент. ''Это выделенный текстовый элемент, он является дочерним элементом параграфа — родительского элемента.''

Будет выводиться так

Это параграф. Это родительский элемент содержащий выделенный текстовый элемент. Это выделенный текстовый элемент, он является дочерним элементом параграфа — родительского элемента.

В PukiWiki есть два вида элементов: "блочные элементы", и "строчные элементы". Блочные элементы, как следует из названия, состоят из целого блока текста, а строчные элементы могут состоять только из части текстового блока, разница между блочными и строчными элементами выглядит следующим образом: 

Далее, приводится описание двух различных видов элементов в деталях.

Блочные элементы

Параграф

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

Строчные элементы Строка, начинающаяся с "~" обозначает начало нового абзаца. Символ "~" также позволяет прямое использование специальных символов (~, -,  +, :, >, |, #, //), которые обычно используются в качестве символов для форматирования. Как правило, эти символы указывают на начало различных видов элементов. Единственный способ помещать в текст видимые специальные символы, в виде обычного текста поместив перед ними символ "~".

Отступ цитирования

Встроенный элемент Символ ">" указывает на начало цитаты. Цитаты состоят из трех уровней отступов, обознаячаясь: ">", ">>", и ">>>".

Список

  1. Встроенный элемент  В начале строки, "+" указывает на начало Нумерованный список. Нумерованный список имеет три уровня именно :"+", "++", и "+++". 

Пункт

Пункт|Пункт Определение *1 Списком определений является строка, начинающаяся с ":" и разделенная символом "|" посередине. Существует три уровня отступов для списка определений *2 : ":", "::", и ":::". 

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

Неформатируемые тексты

"Пробел" в начале строки обозначает начало неформатированного текста. Обыкновенный разрыв строки не вставляет неформатированный текст.

Таблицы

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

bbbbbbbbЗ А Г О Л О В О К
aaaaaПодвалaaaaa
Примеррасположения элементовв каждой ячейке
Выравнивание по левому краю ячейкиПо центруПо правому краю ячейки
По правому краюПо левому краюПо центру
rowspanBLUERED
colspan

Таблицы CSV

,Строчный элемент,Строчный элемент,…

Строчные элементы разделенные символом ","(comma), будут форматированны как таблица. Необходимо запомнить, что символ "," должен стоять перед первым элементом таблицы CSV.

aaaaaaaaabbbbbbbccccccc
слевапо центрусправа
<-- colspanсправа

Заголовки

 *Строчный элемент Строка начинающаяся символом "*" форматируется как заголовок. Существует три уровня отступа заголоков: "*", "**", и "***".

Содержание

 #contents "#contents" в начале строки создает элемент содержания текста на основе заголовков. В основном, "#contents" ставится в верхней части страницы.

LEFT-CENTERED-RIGHT

Слева
По центру
Справа

Написание "LEFT:", "CENTER:", или "RIGHT:" в начале строки выравнивает соответствующим образом каждый строчный элемент.

Линия

---- Четыре символа "-" в начале строки создают горизонтальную линию.

Вставка рисунков

Можно поместить ссылку на рисунок написав #ref(URL файла) в начале стороки.

Пример:

test-sml-icn.gif
test-sml-icn.gif
test-sml-icn.gif

Страница прилагаемого файла

Заменитель

Формы

 #comment "#comment" в начале строки вставляет форму комментария.

 #pcomment "#pcomment" в начале строки вставляет форму комментария. В отличие от "#comment", "#pcomment" сохраняются на отдельной странице. Так же создает дерево комментариев.

#article "#article" в начале строки вставляет простой форум.

 #vote(Выбор1,Выбор2,...) "#vote" в начале строки вставляет форму голования.

Строчные элементы

Strings

 Strings Strings are an Inline Element.

Line Breaks

 Inline Element
Writing "~" at the end of the line inserts End of Line a line break. End of Line is a line break within a Block Element.


Написание &br; вставляет разрыв строки. В отличие от "~" в конце строки,
может использоваться с пунктами, таблицами, или в параметрах блочных элементов начинающихся символом"#". 

Выделение

 Строчный элемент Помещение строчного элемента с '' устанавливает выделение (Bold font).

 Строчный элемент Закрытие строчного элемента с помощью комбинации ''' устанавливает выделение курсивом (Italics).

Размер шрифта

 &size(px){Text you want to change}; &size указывает на размер знаков. Размер должен быть указан в пикселях (px).

Font Color

 Inline Element &color defines the color of any Inline Element.

Deletion Line

 Inline Element Enclosed with %(semicolons), the Inline Element has a line through the middle of the text.

Footnote

 *3

Enclosed with (( and ))(double parenthesis), the Inline Element becomes the footnote and the link to it is placed. 

Embedding Files and Images

 &ref(): File not found: "Attached Filename" at page "FormatRuleRussian";  &ref(): File not found: "URL of File" at page "FormatRuleRussian"; You can attach a file by writing &(file name) at any place in paragraph. You can also place a hypertext link by writing #ref(URL of the file) . If the file attached or linked is an image, the image is displayed.

Anchor

 &aname: Invalid ID string: Anchor Name; &aname makes the anchor for Hyperlink. Place this code where you want to set the link target to go.

Counter

&counter;
&counter(option);

&counter shows the number of access to the current page.

Online Viewer

&online;

&online shows the number of current accessors.

Version

 &version; &version shows the version of current running PukiWiki.
current version = &version;

WikiName

 WikiName WikiName stands for two or more Capitalized Words joined together without spaces, muti-byte characters, symbols, and numbers.

BracketName

 BracketName A string enclosed with [[ and ]] makes a BracketName, which is another link style in Pukiwiki.

InterWiki

 InterWikiName:PageName By separating a BracketName with a colon (:), you can create an InterWiki block, which is another link style in Pukiwiki. The former part must contain an InterWikiName which is defined at InterWikiName which contains a list of defined InterWikiName. (What does this mean? It's not very clear.) The latter part must contain a WikiName or a BracketName without [[ and ]].

Link

 [[Link Name:URL]] Create a link block by separating a BracketName with a colon (:). The former part contains the string to be used for the displayed name of a link. The latter part must contain a URL.

Alias

 Alias Alias enables you to link to a page in Pukiwiki without using the same name of the linked text, as in the case of a Link Block. This is useful when referencing a portion of a given page via an anchor.

Create an Alias by separating a BracketName with the ">" symbol. The former part contains the string to used as the link's name. The latter part must contain a WikiName or a BracketName styled string without [[ and ]].

Use the following syntax to make an "anchor" to direct to a certain part of a page. When using an anchor as an internal link, you can omit the PageName:  Alias  Alias

Entity

*Page Name Entity

 FormatRuleRussian &page; is converted to the name of current editing page.

*Date Entity

&dare;
&time;
&now;

&date; is converted to the current date.
&time; is converted to the current time.
&now; is converted to the current date and time.

*Special Characters

 &heart; &heart; is recognized as a Heart Mark: &heart;  © &copy; is recognized as a Copyright Mark: ©  ® &reg; is recognized as a Registered Trademark:  ®  ™ &trade; is recognized as a Trademark: ™  ² &sup2; is recognized as a 2nd power sign: ²  ³ &sup3; is recognized as a 3rd power sign: ³    &sup3; is recognized as a space :    It is mainly used for adjusting sell width of table.

*Numeric Entity

 &#Decimal-number;  &#xHexadecimal-number; If you insert a decimal number between &# and ; or a hexadecimal number between &# and ;, you can refer to Unicode entities. You may use this inline element to insert characters which you cannot directly type with your keyboard. 

Take a look at the examples in the following table: 

Special entityCodeComments
&#19990;You can use characters from all over the world!
&#9794;It is a man's world.
&#9792;But it would be nothing without a woman.
&#8734;We could go on like this forever...
Ω&#937;But here it must end.

For example, 

For example 、内田百&#38290; is recognized as 内田百閒.

TAB Code

&t; is recognized as TAB Code.   Usually,TAB code can't be written from the keyboard typing in any FORM.*4 But, &t; is converted to TAB Code when the page is stored.  

Others  

Comment line

 // Comments The line began with // at the first column means the comment line. It won't be displayed in the pursed page.


Prohibition

Block Elementcan contain other block elementscan be contained by other block elements
Paragraphnoyes
Preformattednoyes
Headingsnono
Tablenoyes
Table(CSV)noyes
List(unordered)yes*yes
List(ordered)yes*yes
Quoteyes*²yes
Horizontal Linenoyes
LEFT:/CENTER:/RIGHT:noyes
#refnoyes
#contentsnoyes*³
#commentnoyes*³
#pcommentnoyes*³
#articlenoyes*³
#vote(choice1,choice2,...)noyes*³

* As long as the beginning of Child Element is Inline Element or Paragraph,  you can insert a Block Element to the next line. (Please refer to "Nesting Element" for an example.)

*²When Quotation is a Child Element of another Quotation, you need to increase the indentation level by 1.

*³ Due to Pukiwiki's default setting of left margin, this is not recommended.


Compare Link Styles

Here is a section to explain the differences between WikiName, BracketName, InterWiki, Link, and Alias.

WikiName and BracketName

As you know by now, all of them are used in Pukiwiki to make a link to a page. And the difference betweem them is whether or not you can use spaces, multibyte-characters, symbols, and numbers. Thus, a BracketName would be a better choice if you want to avoid the typical WikiName capitalized link style.  Usually, all Capitalized strings will be shown as a link. However, you can disable WikiNames in pukiwiki.ini.php if you think they are annoying. 

InterWiki, Link, and Alias

These styles are very similar, so they might be confusing. But each of them has its own purpose. If you understand the differences, they are all very useful.

First let's focus on their syntax.  pukiwiki:Use PukiWiki............................................[a]  whatever u like...[b]  Another Name................................[c]

[a] ссылка стилизованная InterWiki. [b] обыкновенная ссылка. Both of them will direct us the same page: http:pukiwiki.sourceforge.jp/?Use%20PukiWiki . This is so, because pukiwi is defined in the InterWikiName as follows:

 pukiwiki utf8

Все InterWiki сочетают две информационные части. Первая URL указанная в InterWikiName слева, другая часть справа. InterWikiName что то вроде шортката. Можно указать любой адрес для InterWikiName.

Например, когда необходимо создать ссылку на внешнюю/внутреннюю wiki страницу, не обязательно печатать весь URL каждый раз. В этом случае, как альтернативу, можно указать InterWikiName.

Как видно, [c] является ссылкой стилизованной под Alias. Ее можно использовать it to display a отличный текст ссылки на страницу в PukiWiki.

Link StyleLeft SideRight Side
InterWikiInterWikiName(Defined URL)Additional URL
LinkLink textReal URL
AliasLink textReal URL(WikiName/BracketName)


Nesting Elements

Параграф с элементом выделенного текста

Это параграф, который является родительским элементом содержащим дочерний элемент — выделенный текст.  Это параграф, который является родительским элементом содержащим дочерний элемент — выделенный текст.

Элемент цитаты-со списком

 Уровень[0]  >Уровень цитаты[1]AAA  >Уровень цитаты[1]BBB  >>Уровень цитаты[2]AAA  >>Уровень цитаты[2]BBB  >>>Уровень цитаты[3]

 -Дочерний элемент-уровень отступа списка[1]

ЭЛЕМЕНТТАБЛИЦЫСЛЕДУЮЩИЙвстрочномэлементесписка

 --Дочерний элемент-уровень отступа списка[2]  
Разрыв строки внутри элемента  ---Дочерний элемент-уровень отступа списка[3]  --Дочерний элемент-уровень отступа списка[2]  ---Дочерний элемент-уровень отступа списка[3]  >Уровень отступа цитирования[1]  >>Уровень отступа цитирования[2]  <<Выход из элемента второго уровня отступа цитирования  >>>Уровень отступа цитирования[3]AAA  >>>Уровень отступа цитирования[3]BBB  -Дочерний элемент-уровень отступа списка[1]  --Дочерний элемент-уровень отступа списка[2]  ---Дочерний элемент-уровень отступа списка[3]

Уровень[0]

Уровень цитирования[1]AAA

Уровень цитирования[1]BBB

Уровень цитирования[2]AAA

Уровень цитирования[2]BBB

Уровень цитирования[3]

  • Дочерний элемент-уровень списка[1]
    ЭЛЕМЕНТТАБЛИЦЫСЛЕДУЮЩИЙвстрочномэлементесписка
    • Дочерний элемент-уровень списка[2]
      Разрыв строки внутри элемента
      • Дочерний элемент-уровень отступа списка[3]
    • Дочерний элемент-уровень отступа списка[2]
      • Дочерний элемент-уровень отступа списка[3]

        Уровень отступа цитаты[1]

        Уровень отступа цитаты[2]

        Выход из элемента второго уровня цитирования

        Уровень отступа цитаты[3]AAA

        Уровень отступа цитаты[3]BBB

        • Дочерний элемент-уровень отступа списка[1]
          • Дочерний элемент-уровень отступа списка[2]
            • Дочерний элемент-уровень отступа списка[3]

*1 термин "определения" требует лучшего перевода
*2 термин "определения" требует лучшего перевода
*3 Inline Element
*4 Pasting from Clipboard is available.

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2011-09-08 (木) 21:49:11
Site admin: PukiWiki Development Team

PukiWiki 1.5.3+ © 2001-2020 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u12. HTML convert time: 0.388 sec.

OSDN