Diagram для «ДокуВики»

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

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

<diagram> 
Спецификация диаграммы 
</diagram>

• Релиз: 2021-02-21.
• Репозиторий:http://nikita.melnichenko.name/projects/dokuwiki-diagram/?lang=en
• Совместимость с «Докувики»: 04.04.2023 «Джек Джекрам»

• 2009-05-28 «Манеры Фрустерика»
  • Не работает: auth_aclquickcheck не может обрабатывать начальные двоеточия в идентификаторах, поэтому я чувствую, что это все еще не работает в «ДокуВики», но, по крайней мере, плагин может правильно учитывать ACL .

Используйте менеджер плагинов для установки или…

1. скачать zip-файл
2. распаковать его в<dokuwiki>/lib/plugins/
3. войдите как администратор и измените плагин в менеджере конфигурации

Спецификация диаграммы представляет собой многострочное выражение. Каждая строка состоит из управляющих символов, определяющих связи между блоками, и последовательностей букв, определяющих блоки. Эти сущности разделяются специальным символом `|'. Например, следующая спецификация

<diagram>
| AAA |-| BBB |
| |:| | | | | |
| |L|~|~| CCC |
</diagram>

определяет эту диаграмму:

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

<diagram>
| root |-| 1-st branch |
| |:| | | | | |
| |L|~|~| 2-nd branch |
</diagram>

К сожалению, этот метод ломает текстовое представление диаграммы (для больших диаграмм это приводит к сложности изменения вики-кода), а также не позволяет использовать вики-синтаксис внутри блока. Чтобы преодолеть это, вы должны рассматривать последовательности букв, цифр и подчеркивания как аббревиатуры и расшифровывать их в конце строки, используя знак равенства и `|' символ в качестве разделителя. Например:

<diagram>
| AAA |-| BBB |AAA=root|BBB=1<sup>st</sup> branch (see [[wp>Branch]])
| |:| | | | | |
| |L|~|~| CCC |CCC=2<sup>nd</sup> branch\\ **(very important branch)**
</diagram>

С помощью таких диаграмм можно описать генеалогическое древо.

<diagram>
| | | Dad |y| Mom | | |Dad=Daddy|Mom=Mommy
| |,|-|-|-|+|-|-|-|.| |
| Sys | |  Me | | Bro |Sys=Syster|Bro=Brother
</diagram>

Все типы соединений показаны в следующей таблице:

,	.	`	'		v	(	)	-	!	+
F	7	L	J	A	V	C	D	~	:	%
y	h	}	{	p	b	]	[	*	#

Мы будем называть эти элементы тайлами соединения.

Стиль элементов диаграммы Вы можете изменить цвет границы и цвет фона блока. Это делается путем указания параметров блока в описании аббревиатуры непосредственно перед знаком равенства и в фигурных скобках. Параметры должны быть отформатированы как ключ:значение и разделены точкой с запятой. В текущей версии плагина поддерживаются два ключа: border-colorдля цвета рамки и background-colorдля цвета фона. Значения цвета должны быть указаны в формате CSS2 , включая ключевые слова цвета SVG .

<diagram>
| AAA | | | | |F|~|~|~|7| |AAA{border-color:blue;background-color:lightgreen}=Border is blue,\\ background is lightgreen
| |!| | | | | CCC | | DDD |CCC{border-color:#a9c}=Border is #a9c,\\ background is transparent|DDD{border-color:silver;background-color:silver;}=Border is silver,\\ background is silver
| BBB | | | | | | | | | | |BBB{border-color:rgb(0%,50%,0%);background-color:#abcdef}=Border is green,\\ background is #abcdef
</diagram>

Также можно настроить выравнивание текста и внутренний отступ с помощью text-align и padding свойств:

<diagram>
|Left|                 |Left{text-align:left;}=Text is\\ aligned to the left
| |!|
| |`|-|-|Center|       |Center=By default text is aligned\\ to the center
| | | | |  |!|
| | | | |  |`|-|-|Right|Right{text-align:right;padding:1em}=Align text\\ to the right\\ and setup indents
</diagram>

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

<diagram>
| AAA |-| BBB |
| |:| | | | | | | DDD |
| |L|~|~| CCC |
</diagram>

с

<diagram>
| AAA |-|-|-| BBB | | | | | | |
| |:|
| |:| | | | | | | | | | | DDD |
| |:|
| |L|~|~|~|~| CCC |
</diagram>

Вы можете использовать стрелки на диаграммах. Например,

<diagram>
|  AAA  |-@2|  BBB  |-@a|  EEE   |
| |:@1| |   | |!@4| |   | |}@72|-|-| GGG |
|  DDD  |~@8|  CCC  |   |  FFF   |
</diagram>

Для вставки стрелки необходимо после управляющего символа поставить «@» и один или два символа настройки направления. Первый символ устанавливает стрелки, направленные из центра соединительной плитки. Это шестнадцатеричное число, имеющее по 4 бита для каждого из 4 направлений: вверх, вправо, вниз, влево. Каждый бит устанавливает наличие стрелки в соответствующем направлении. Если вы не знакомы с шестнадцатеричным представлением, используйте следующий алгоритм. Рассчитайте сумму чисел направления, используя эту таблицу:

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

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

Пример: генеалогическое древо Кеннеди. Основной синтаксис для диаграмм был заимствован из Википедии. Сравните генеалогическое древо Кеннеди с генеалогическим древом ниже.

<diagram>
| | | | | JAK |y| MAK | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |JAK=James Kennedy\\ (c. 1770 - c. 1840)|MAK=Maria Kennedy\\ (c. 1775 - 1835)
| | | | | | | |!| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |
| | | | | | | PAK |y| BMK | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | |PAK=[[wp>Patrick Kennedy (1823–1858)|Patrick Kennedy]]\\ (c. 1823 - 1858)|BMK=[[wp>Bridget Murphy Kennedy|Bridget Murphy]]\\ (1824 - 1888)
| |,|-|-|-|v|-|-|-|+|-|-|-|v|-|-|-|.| | | | | | | | | | | | | | | | | | | | | | | | | |
| MLK | | JLK | | JOK | | MMK | | PJK |y| MAH | | | | | | | | | | | | | | | | | | | | |MLK=Mary L. Kennedy\\ (1851 - 1926)|JLK=Joanna L. Kennedy\\ (1852 - 1926)|JOK=John Kennedy\\ (1854 - 1855)|MMK=Margaret M. Kennedy\\ (1855 - 1929)|PJK=[[wp>P. J. Kennedy|Patrick Joseph Kennedy]]\\ (1858 - 1929)|MAH=[[wp>Mary Augusta Hickey Kennedy|Mary Augusta Hickey]]\\ (1857 - 1923)
| | | | | | | | | | | | | | | | | | | |!| | | | | | | | | | | | | | | | | | | | | | | |
| | | | | | | | | | | | | | | | | | | JPK |y| RFK | | | | | | | | | | | | | | | | | | |JPK=[[wp>Joseph P. Kennedy, Sr.]]\\ (1888 - 1969)|RFK=[[wp>Rose Fitzgerald Kennedy|Rose Elizabeth Fitzgerald]]\\ (1890 - 1995)
| | | | | |,|-|-|-|v|-|-|-|v|-|-|-|v|-|-|-|+|-|-|-|v|-|-|-|v|-|-|-|v|-|-|-|.| | | | | |
| | | | | JPK | | JFK |7| ROK | | KAK |7| EMK |F| PAK |F| RFK |F| JAK |F| EDK | | | | |JPK=[[wp>Joseph Patrick Kennedy Jr.]]\\ (1915 - 1944)|JFK=[[wp>John Fitzgerald Kennedy]]\\ (1917 - 1963)|ROK=[[wp>Rosemary Kennedy]]\\ (1918 - 2005)|KAK=[[wp>Kathleen Cavendish, Marchioness of Hartington]]\\ (1920 - 1948)|EMK=[[wp>Eunice Kennedy Shriver]]\\ (b. 1921)|PAK=[[wp>Patricia Kennedy Lawford]]\\ (1924 - 2006)|RFK=[[wp>Robert Francis Kennedy]]\\ (1925 – 1968)|JAK=[[wp>Jean Kennedy Smith]]\\ (b. 1928)|EDK=[[wp>Edward Moore Kennedy]]\\ (b. 1932)
| | | | | | | | | | | |:| | | | | | | |:| |:| |:| |F|~|J| | | |:| | | |:| | | | | | | |
| | | | | | | | JLB |y|J| | | | WJC |~|J| |:| |:| |:|F|~|~|~|~|J| | | |:| | | | | | | |JLB=[[wp>Jacqueline Kennedy Onassis|Jacqueline Lee Bouvier]]\\ (1929 - 1994)|WJC=[[wp>William John Robert Cavendish, Marquess of Hartington]]\\ (1917 - 1944)
| | | | |,|-|-|-|v|-|^|-|v|-|-|-|.| | | | |:| |:| |:|:| | | | | JBK |y|J| | | | | | | |JBK=[[wp>Joan Bennett Kennedy|Virginia Joan Bennett]]\\ (b. 1936)
| | | | ARK | | CBK | | JKJ | | PBK | | | |:| |:| |:|:| | |,|-|-|-|v|^|-|-|.| | | | | |ARK=Arabella Kennedy\\ (1956 - 1956)|CBK=[[wp>Caroline Kennedy]]\\ (b. 1957)|JKJ=[[wp>John F. Kennedy, Jr.]]\\ (1960 - 1999)|PBK=[[wp>Patrick Bouvier Kennedy]]\\ (1963 - 1963)
| | | | | | | | | | | | | | | | | | | | | |:| |:| |:|:| | KAK | | EMK | | PJK | | | | |KAK=[[wp>Kara Anne Kennedy]]\\ (b. 1960)|EMK=[[wp>Edward Kennedy, Jr.]]\\ (b. 1961)|PJK=[[wp>Patrick J. Kennedy]]\\ (b. 1967)
| | | | | | | | | SAS |y|~|~|~|~|~|~|~|~|~|J| |:| |:|:| | | | | | | | | | | | | | | | |SAS=[[wp>Sargent Shriver]]\\ (b. 1915)
| |,|-|-|-|v|-|-|-|v|-|^|-|v|-|-|-|.| | |F|~|~|J| |:|L|~|~|~|~|y| SES | | | | | | | | |SES=[[wp>Stephen Edward Smith]]\\ (1927-1990)
| RSS | | MOS | | TPS | | MKS | | APS | |:| |F|~|~|J| | | | | |!| | | | | | | | | | | |RSS=[[wp>Robert Sargent Shriver III]]\\ (b. 1954)|MOS=[[wp>Maria Shriver]]\\ (b. 1955)|TPS=[[wp>Timothy Perry Shriver]]\\ (b. 1959)|MKS=[[wp>Mark Kennedy Shriver]]\\ (b. 1964)|APS=[[wp>Anthony Paul Kennedy Shriver]]\\ (b. 1965)
| | | | | | | | | | | | | | | | | | | | |:| |:| | |,|-|-|-|v|-|^|-|v|-|-|-|.| | | | | |
| | | | | | | | | | PEL |y|~|~|~|~|~|~|~|J| |:| | SEJ | | WKS | | AMS | | KMS | | | | |PEL=[[wp>Peter Lawford]]\\ (1923 - 1984)|SEJ=Stephen Edward Smith, Jr.\\ (b. 1957)|WKS=[[wp>William Kennedy Smith]]\\ (b. 1960)|AMS=Amanda Mary Smith\\ (b. 1967)|KMS=Kym Maria Smith\\ (b. 1972)
| | | | | | |,|-|-|-|v|-|^|-|v|-|-|-|.| | | |:| | | | | | | | | | | | | | | | | | | | |
| | | | | | CKL | | SML | | VFL | | REL | | |L|y| ETS | | | | | | | | | | | | | | | | |CKL=[[wp>Christopher Lawford]]\\ (b. 1955)|SML=Sydney Maleia Lawford\\ (b.1956)|VFL=Victoria Francis Lawford\\ (b. 1958)|REL=Robin Elizabeth Lawford\\ (b. 1961)|ETS=[[wp>Ethel Skakel Kennedy|Ethel Skakel]]\\ (b. 1928)
| |,|-|-|-|v|-|-|-|v|-|-|-|v|-|-|-|v|-|-|-|v|-|^|-|v|-|-|-|v|-|-|-|v|-|-|-|v|-|-|-|.| |
| KHK | | JPK | | RFK | | DAK | | MCK | | MLK | | MKK | | CGK | | MMK | | DHK | | REK |KHK=[[wp>Kathleen Kennedy Townsend]]\\ (b. 1951)|JPK=[[wp>Joseph Patrick Kennedy II]]\\ (b. 1952)|RFK=[[wp>Robert F. Kennedy, Jr.]]\\ (b. 1954)|DAK=[[wp>David Kennedy]]\\ (1955 - 1984)|MCK=[[wp>Courtney Kennedy Hill]]\\ (b. 1956)|MLK=[[wp>Michael LeMoyne Kennedy]]\\ (1958 - 1997)|MKK=[[wp>Kerry Kennedy]]\\ (b. 1959)|CGK=[[wp>Christopher George Kennedy]]\\ b. 1963)|MMK=[[wp>Matthew Maxwell Taylor Kennedy]]\\ (b. 1965)|DHK=[[wp>Douglas Harriman Kennedy]]\\ (b. 1967)|REK=[[wp>Rory Kennedy]]\\ (b. 1968)
</diagram>

Визуализированное дерево

Пример: Генеалогическое древо Кеннеди со стрелками Теперь добавим стрелки. Здесь они немного избыточны, но это для большего разнообразия.

<diagram>
| |   | | |    JAK    |y@aa|     MAK     |    |    |   |   | |   |   |   |    | |    | |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |JAK=James Kennedy\\ (c. 1770 - c. 1840)|MAK=Maria Kennedy\\ (c. 1775 - 1835)
| |   | | |   |   |   |!@4 |   |    |    |    |    |   |   | |   |   |   |    | |    | |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |
| |   | | |   |   |    PAK     |y@aa|     BMK      |   |   | |   |   |   |    | |    | |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |PAK=[[wp>Patrick Kennedy (1823–1858)|Patrick Kennedy]]\\ (c. 1823 - 1858)|BMK=[[wp>Bridget Murphy Kennedy|Bridget Murphy]]\\ (1824 - 1888)
| |,@4|-|-|-  |v@4|-  |-   |-  |+@e |-   |-   |-   |v@4|-  |-|-  |.@4|   |    | |    | |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |
|  MLK  | |    JLK    |    |     JOK     |    |    MMK     | |    PJK    |y@aa|  MAH   |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |MLK=Mary L. Kennedy\\ (1851 - 1926)|JLK=Joanna L. Kennedy\\ (1852 - 1926)|JOK=John Kennedy\\ (1854 - 1855)|MMK=Margaret M. Kennedy\\ (1855 - 1929)|PJK=[[wp>P. J. Kennedy|Patrick Joseph Kennedy]]\\ (1858 - 1929)|MAH=[[wp>Mary Augusta Hickey Kennedy|Mary Augusta Hickey]]\\ (1857 - 1923)
| |   | | |   |   |   |    |   |    |    |    |    |   |   | |   |   |   |!@4 | |    | |    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |
| |   | | |   |   |   |    |   |    |    |    |    |   |   | |   |   |   JPK    |y@aa|  RFK   |   |   |    | |   | |    | |   |    |    | |   | | | |   | |JPK=[[wp>Joseph P. Kennedy, Sr.]]\\ (1888 - 1969)|RFK=[[wp>Rose Fitzgerald Kennedy|Rose Elizabeth Fitzgerald]]\\ (1890 - 1995)
| |   | | |   |,@4|-  |-   |-  |v@4 |-   |-   |-   |v@4|-  |-|-  |v@4|-  |-   |-|+@e |-|-   |-|v@4|-  |-   |-|v@4|-|-   |-|v@4|-   |-   |-|.@4| | | |   | |
| |   | | |    JPK    |    |     JFK     |7@88|    ROK     | |    KAK    |7@88|  EMK   |F@22|   PAK   |F@22|  RFK  |F@22|   JAK    |F@22|  EDK  | | |   | |JPK=[[wp>Joseph Patrick Kennedy Jr.]]\\ (1915 - 1944)|JFK=[[wp>John Fitzgerald Kennedy]]\\ (1917 - 1963)|ROK=[[wp>Rosemary Kennedy]]\\ (1918 - 2005)|KAK=[[wp>Kathleen Cavendish, Marchioness of Hartington]]\\ (1920 - 1948)|EMK=[[wp>Eunice Kennedy Shriver]]\\ (b. 1921)|PAK=[[wp>Patricia Kennedy Lawford]]\\ (1924 - 2006)|RFK=[[wp>Robert Francis Kennedy]]\\ (1925 – 1968)|JAK=[[wp>Jean Kennedy Smith]]\\ (b. 1928)|EDK=[[wp>Edward Moore Kennedy]]\\ (b. 1932)
| |   | | |   |   |   |    |   |    |    |:   |    |   |   | |   |   |   |:   | |:@4 | |:   | |F  |~  |J   | |   | |:   | |   |    |:   | |   | | | |   | |
| |   | | |   |   |   |     JLB     |y@aa|J   |    |   |   |   WJC   |~@2|J   | |:   | |:   | |:  |F  |~   |~|~  |~|J   | |   |    |:   | |   | | | |   | |JLB=[[wp>Jacqueline Kennedy Onassis|Jacqueline Lee Bouvier]]\\ (1929 - 1994)|WJC=[[wp>William John Robert Cavendish, Marquess of Hartington]]\\ (1917 - 1944)
| |   | | |,@4|-  |-  |-   |v@4|-   |^@a |-   |v@4 |-  |-  |-|.@4|   |   |    | |:   | |:   | |:  |:  |    | |   | |   JBK    |y@aa|J   | |   | | | |   | |JBK=[[wp>Joan Bennett Kennedy|Virginia Joan Bennett]]\\ (b. 1936)
| |   | |   ARK   |   |     CBK     |    |     JKJ     |   |   PBK   |   |    | |:   | |:   | |:  |:  |    | |,@4|-|-   |-|v@4|^@a |-   |-|.@4| | | |   | |ARK=Arabella Kennedy\\ (1956 - 1956)|CBK=[[wp>Caroline Kennedy]]\\ (b. 1957)|JKJ=[[wp>John F. Kennedy, Jr.]]\\ (1960 - 1999)|PBK=[[wp>Patrick Bouvier Kennedy]]\\ (1963 - 1963)
| |   | | |   |   |   |    |   |    |    |    |    |   |   | |   |   |   |    | |:@4 | |:@4 | |:@4|:@4|    |  KAK  |    |   EMK    |    |  PJK  | | |   | |KAK=[[wp>Kara Anne Kennedy]]\\ (b. 1960)|EMK=[[wp>Edward Kennedy, Jr.]]\\ (b. 1961)|PJK=[[wp>Patrick J. Kennedy]]\\ (b. 1967)
| |   | | |   |   |   |    |     SAS     |y@aa|~   |~  |~  |~|~  |~  |~  |~   |~|J   | |:   | |:  |:  |    | |   | |    | |   |    |    | |   | | | |   | |SAS=[[wp>Sargent Shriver]]\\ (b. 1915)
| |,@4|-|-|-  |v@4|-  |-   |-  |v@4 |-   |^@a |-   |v@4|-  |-|-  |.@4|   |    |F|~   |~|J   | |:  |L  |~   |~|~  |~|y@aa|   SES    |    | |   | | | |   | |SES=[[wp>Stephen Edward Smith]]\\ (1927-1990)
|  RSS  | |    MOS    |    |     TPS     |    |    MKS     | |    APS    |    |:|    |F|~   |~|J  |   |    | |   | |!   | |   |    |    | |   | | | |   | |RSS=[[wp>Robert Sargent Shriver III]]\\ (b. 1954)|MOS=[[wp>Maria Shriver]]\\ (b. 1955)|TPS=[[wp>Timothy Perry Shriver]]\\ (b. 1959)|MKS=[[wp>Mark Kennedy Shriver]]\\ (b. 1964)|APS=[[wp>Anthony Paul Kennedy Shriver]]\\ (b. 1965)
| |   | | |   |   |   |    |   |    |    |    |    |   |   | |   |   |   |    |:|    |:|    | |,@4|-  |-   |-|v@4|-|^@a |-|v@4|-   |-   |-|.@4| | | |   | |
| |   | | |   |   |   |    |   |     PEL      |y@aa|~  |~  |~|~  |~  |~  |~   |J|    |:|    |   SEJ   |    |  WKS  |    |   AMS    |    |  KMS  | | |   | |PEL=[[wp>Peter Lawford]]\\ (1923 - 1984)|SEJ=Stephen Edward Smith, Jr.\\ (b. 1957)|WKS=[[wp>William Kennedy Smith]]\\ (b. 1960)|AMS=Amanda Mary Smith\\ (b. 1967)|KMS=Kym Maria Smith\\ (b. 1972)
| |   | | |   |   |,@4|-   |-  |-   |v@4 |-   |^@a |-  |v@4|-|-  |-  |.@4|    | |    |:|    | |   |   |    | |   | |    | |   |    |    | |   | | | |   | |
| |   | | |   |    CKL     |   |     SML      |    |   VFL   |   |    REL     | |    |L|y@aa|   ETS   |    | |   | |    | |   |    |    | |   | | | |   | |CKL=[[wp>Christopher Lawford]]\\ (b. 1955)|SML=Sydney Maleia Lawford\\ (b.1956)|VFL=Victoria Francis Lawford\\ (b. 1958)|REL=Robin Elizabeth Lawford\\ (b. 1961)|ETS=[[wp>Ethel Skakel Kennedy|Ethel Skakel]]\\ (b. 1928)
| |,@4|-|-|-  |v@4|-  |-   |-  |v@4 |-   |-   |-   |v@4|-  |-|-  |v@4|-  |-   |-|v@4 |-|^@a |-|v@4|-  |-   |-|v@4|-|-   |-|v@4|-   |-   |-|v@4|-|-|-|.@4| |
|  KHK  | |    JPK    |    |     RFK     |    |    DAK     | |    MCK    |    |  MLK   |    |   MKK   |    |  CGK  |    |   MMK    |    |  DHK  | |  REK  |KHK=[[wp>Kathleen Kennedy Townsend]]\\ (b. 1951)|JPK=[[wp>Joseph Patrick Kennedy II]]\\ (b. 1952)|RFK=[[wp>Robert F. Kennedy, Jr.]]\\ (b. 1954)|DAK=[[wp>David Kennedy]]\\ (1955 - 1984)|MCK=[[wp>Courtney Kennedy Hill]]\\ (b. 1956)|MLK=[[wp>Michael LeMoyne Kennedy]]\\ (1958 - 1997)|MKK=[[wp>Kerry Kennedy]]\\ (b. 1959)|CGK=[[wp>Christopher George Kennedy]]\\ b. 1963)|MMK=[[wp>Matthew Maxwell Taylor Kennedy]]\\ (b. 1965)|DHK=[[wp>Douglas Harriman Kennedy]]\\ (b. 1967)|REK=[[wp>Rory Kennedy]]\\ (b. 1968)
</diagram>