Плагин Counter. Создание автоматической нумерации на викистраницах (original) (raw)

Плагин добавляет вики-команду (:counter:), позволяющую организовывать автоматическую нумерацию чего-либо на странице.

Counter 1.3.4 (Требуемая версия OutWiker: 4.0.0.942 и выше)

Counter 1.3.3 (Требуемая версия OutWiker: 3.3.0.934 и выше)

Counter 1.3.2 (Требуемая версия OutWiker: 3.2.0.922 и выше)

Использование

(:counter параметры... :)

Параметры

Все параметры являются необязательными и могут быть установлены через диалог.

name - задает имя счетчика. Счетчики с разными именами имеют независимые текущие значения.
start - значение, с которого нужно начинать новый отсчет. С помощью этого параметра можно "сбрасывать" счетчик к нужному значению.
step - приращение для значения счетчика.
parent - имя родительского счетчика для создания нумерации вроде 1.1, 1.2.3 и т.п.
separator - разделитель между данным счетчиком и родительским (значение по умолчанию - точка).
hide - параметр указывает, что счетчик нужно скрыть, но при этом увеличить его значение.

Примеры использования

Пример 1

Если нам нужно иметь только одну нумерацию на странице, можно воспользоваться командой (:counter:) без параметров.

Например:

Рисунок (:counter:).

В результате мы получим следующую нумерацию:

Рисунок 1.

Рисунок 2.

Рисунок 3.

Пример 2

Допустим, мы хотим пронумеровать на странице и рисунки, и формулы. В этом случае воспользуемся параметром name. Счетчики с разными значением параметра name нумеруются независимо друг от друга. Отсутствие параметра name равносильно name=""

Например:

Рисунок (:counter name="image":).

Формула ((:counter name="eq":))
Формула ((:counter name="eq":))

Рисунок (:counter name="image":).

Формула ((:counter name="eq":))
Формула ((:counter name="eq":))

Рисунок (:counter name="image":).

Результат будет выглядеть следующим образом:

Рисунок 1.

Формула (1)
Формула (2)

Рисунок 2.

Формула (3)
Формула (4)

Рисунок 3.

Того же результата можно достичь, если убрать из счетчика одно из имен ("image" или "eq"), но делать этого не рекомендуется, поскольку так лучше видно, какой счетчик за что отвечает.

Пример 3

Параметр start позволяет "сбросить" счетчик к какому-то начальному значению, от которого пойдет новый отсчет.

Например:

Рисунок (:counter:).

Рисунок (:counter start=10:).

Рисунок (:counter:).

Результат будет выглядеть следующим образом:

Рисунок 1.

Рисунок 2.

Рисунок 10.

Рисунок 11.

Пример 4

Параметр step указывает, что счетчик должен увеличить свое значение не на 1, а на заданное число, которое может быть отрицательным.

Например:

Рисунок (:counter:).

Рисунок (:counter step=2:).

Рисунок (:counter step=3:).

Рисунок (:counter step=-10:).

Результат будет выглядеть следующим образом:

Рисунок 1.

Рисунок 2.

Рисунок 4.

Рисунок 7.

Рисунок -3.

Пример 5

Если у вас на странице есть разделы, то это хороший объект для автоматической нумерации. Однако часто кроме разделов есть еще подразделы, номера которых зависят от родительского раздела, например, 1.2, 1.3, 1.2.3, 1.2.4, 1.2.5 и т.д. Для создания такой нумерации с помощью команды (:counter:) предназначен параметр parent, который должен быть равен имени (параметр name) родительского счетчика.

Например:

Раздел (:counter name="level 1":)
Раздел (:counter name="level 1":)

Раздел (:counter name="level 2" parent="level 1":)
Раздел (:counter name="level 3" parent="level 2":)
Раздел (:counter name="level 3" parent="level 2":)
Раздел (:counter name="level 3" parent="level 2":)

Раздел (:counter name="level 2" parent="level 1":)
Раздел (:counter name="level 2" parent="level 1":)

Раздел (:counter name="level 3" parent="level 2":)
Раздел (:counter name="level 3" parent="level 2":)
Раздел (:counter name="level 3" parent="level 2":)

Раздел (:counter name="level 1":)
Раздел (:counter name="level 2" parent="level 1":)
Раздел (:counter name="level 2" parent="level 1":)
Раздел (:counter name="level 2" parent="level 1":)

Результат будет выглядеть следующим образом:

Раздел 1
Раздел 2

Раздел 2.1
Раздел 2.1.1
Раздел 2.1.2
Раздел 2.1.3

Раздел 2.2
Раздел 2.3

Раздел 2.3.1
Раздел 2.3.2
Раздел 2.3.3

Раздел 3
Раздел 3.1
Раздел 3.2
Раздел 3.3

Пример 6

Если вы используете параметр name, то вы можете поменять разделитель между значениями родительского и дочернего счетчиков. Для этого используется параметр separator.

Например:

Раздел (:counter name="level 1":)
Раздел (:counter name="level 2" parent="level 1" separator=":":)
Раздел (:counter name="level 3" parent="level 2" separator="-":)
Раздел (:counter name="level 3" parent="level 2" separator="-":)
Раздел (:counter name="level 3" parent="level 2" separator="-":)

Результат будет выглядеть следующим образом:

Раздел 1
Раздел 1:1
Раздел 1:1-1
Раздел 1:1-2
Раздел 1:1-3

Пример 7

Иногда нужно, чтобы счетчик увеличился на единицу, но при этом значение не показывалось. Например, если у вас идет нумерация разделов 1.1, 1.2, 1.3, после чего должен начаться раздел 2.1, 2.2, 2.3, минуя раздел 2. Для того, чтобы счетчик увеличился на какое-то значение (по умолчанию на 1, если не использовались параметры step или start), но при этом не отображался, используется параметр hide.

Например:

(:counter name="level 1" hide:)
Раздел (:counter name="level 2" parent="level 1":)
Раздел (:counter name="level 2" parent="level 1":)

Результат будет выглядеть следующим образом:

Раздел 1.1
Раздел 1.2

Раздел 2.1
Раздел 2.2

Раздел 3.1
Раздел 3.2

История изменений

1.3.4 (14.09.2024)

Переход на новый API.

1.3.3 (22.06.2024)

Использование векторной иконки.

1.3.2 (03.05.2023)

Использование более новой версии API.

1.3.1 (29.12.2020)

Исправлена опечатка в описании плагина.

1.3 (19.10.2019)

Переход на новую версию API.

1.2 (26.08.2018)

Добавлена немецкая локализация.

1.1 (15.02.2018)

Добавлена поддержка OutWiker 2.1. Переход на Python 3.6.

1.0.6 (17.10.2016)

Добавлена поддержка OutWiker 2.0.

1.0.5 (20.08.2016)

Добавлена поддержка шведского языка.

1.0.3 (20.01.2015)

Небольшие улучшения в интерфейсе.
Исправление ошибок.
Подчистка кода.

1.0.2 (11.09.2014)

Добавлена итальянская локализация.
Исправление ошибок.

1.0.1 (13.07.2014)

Исправлен вывод ошибок при попытке использования плагина в неподдерживаемых версиях OutWiker.

1.0 (24.06.2014)

Первая версия.