Шаблон:Todo/Документация
Материал из MachineLearning.
(Различия между версиями)
м |
|||
| Строка 1: | Строка 1: | ||
| - | Шаблон предназначен для оформления пунктов [[MachineLearning:ToDo | + | Шаблон предназначен для оформления пунктов в списках сбора требований, например [[MachineLearning:ToDo]]. |
Перед началом списка пунктов необходимо открыть таблицу строкой <code><nowiki>{|</nowiki></code>, | Перед началом списка пунктов необходимо открыть таблицу строкой <code><nowiki>{|</nowiki></code>, | ||
а по окончании списка — закрыть таблицу строкой <code><nowiki>|}</nowiki></code>. | а по окончании списка — закрыть таблицу строкой <code><nowiki>|}</nowiki></code>. | ||
Оформление таблицы оставлено за пользователем (можно скопировать первую строку из примера, приведённого ниже). | Оформление таблицы оставлено за пользователем (можно скопировать первую строку из примера, приведённого ниже). | ||
| + | |||
| + | == Параметры шаблона == | ||
| + | |||
| + | '''Первый параметр''' указывает на тип пункта, сейчас поддерживаются | ||
| + | <code><nowiki>bug</nowiki></code>, | ||
| + | <code><nowiki>warn</nowiki></code>, | ||
| + | <code><nowiki>wish</nowiki></code>. | ||
| + | |||
| + | '''Второй параметр''' — основной текст сообщения об ошибке, предупреждения, замечания или требования. | ||
| + | |||
| + | '''Третий параметр''' необязателен. | ||
| + | Если он указан, это означает, что для данного сообщения есть ответ. | ||
| + | Если это слово <code><nowiki>done</nowiki></code>, то содержимое сообщения зачёркивается как выполненое. | ||
| + | |||
| + | '''Четвёртый параметр''' также необязателен. Это текст ответа на сообщение. | ||
'''Пример исходной разметки:''' | '''Пример исходной разметки:''' | ||
| Строка 11: | Строка 26: | ||
{{todo|warn|Описание предупреждения — ~~~~}} | {{todo|warn|Описание предупреждения — ~~~~}} | ||
{{todo|wish|Описание пожелания — ~~~~}} | {{todo|wish|Описание пожелания — ~~~~}} | ||
| - | {{todo|bug|Описание ошибки — ~~~~|done | + | {{todo|bug|Описание ошибки — ~~~~|done}} |
{{todo|warn|Описание предупреждения — ~~~~|done|Исправлено — ~~~~}} | {{todo|warn|Описание предупреждения — ~~~~|done|Исправлено — ~~~~}} | ||
{{todo|wish|Описание пожелания — ~~~~|done|Исправлено — ~~~~}} | {{todo|wish|Описание пожелания — ~~~~|done|Исправлено — ~~~~}} | ||
| Строка 22: | Строка 37: | ||
{{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | {{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | ||
{{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | {{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | ||
| - | {{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done | + | {{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done}} |
| - | {{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done| | + | {{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Исправлено — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} |
{{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Сделано — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | {{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Сделано — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}} | ||
|} | |} | ||
Версия 08:34, 23 апреля 2008
Шаблон предназначен для оформления пунктов в списках сбора требований, например MachineLearning:ToDo.
Перед началом списка пунктов необходимо открыть таблицу строкой {|,
а по окончании списка — закрыть таблицу строкой |}.
Оформление таблицы оставлено за пользователем (можно скопировать первую строку из примера, приведённого ниже).
Параметры шаблона
Первый параметр указывает на тип пункта, сейчас поддерживаются
bug,
warn,
wish.
Второй параметр — основной текст сообщения об ошибке, предупреждения, замечания или требования.
Третий параметр необязателен.
Если он указан, это означает, что для данного сообщения есть ответ.
Если это слово done, то содержимое сообщения зачёркивается как выполненое.
Четвёртый параметр также необязателен. Это текст ответа на сообщение.
Пример исходной разметки:
{| cellpadding="0px" cellspacing="0px" width="100%" style="border: 1px solid #AAAAAA; margin: 1em auto 1em auto; padding:.4em;"
{{todo|bug|Описание ошибки — ~~~~}}
{{todo|warn|Описание предупреждения — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~}}
{{todo|bug|Описание ошибки — ~~~~|done}}
{{todo|warn|Описание предупреждения — ~~~~|done|Исправлено — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~|done|Исправлено — ~~~~}}
|}
Результат:
