Шаблон:Todo/Документация

Материал из MachineLearning.

(Различия между версиями)
Перейти к: навигация, поиск
м
Текущая версия (12:51, 15 февраля 2010) (править) (отменить)
(категория)
 
(11 промежуточных версий не показаны.)
Строка 1: Строка 1:
-
Шаблон предназначен для оформления пунктов [[MachineLearning:ToDo|ToDo-листа]].
+
Шаблон предназначен для оформления пунктов в списках сбора требований, например [[MachineLearning:ToDo]].
-
Перед началом списка пунктов необходимо открыть таблицу строкой <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>, то содержимое сообщения зачёркивается как выполненное.
 +
 
 +
'''Четвёртый параметр''' также необязателен. Это текст ответа на сообщение.
 +
 
 +
'''Пример исходной разметки:'''
<pre>
<pre>
-
{|
 
{{todo|bug|Описание ошибки — ~~~~}}
{{todo|bug|Описание ошибки — ~~~~}}
{{todo|warn|Описание предупреждения — ~~~~}}
{{todo|warn|Описание предупреждения — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~}}
-
{{todo|bug|Описание ошибки — ~~~~|done|Исправлено — ~~~~}}
+
{{todo|bug|Описание ошибки — ~~~~|done}}
-
{{todo|warn|Описание предупреждения — ~~~~|done|Исправлено — ~~~~}}
+
{{todo|warn|Описание предупреждения — ~~~~|ОК|Исправлено — ~~~~}}
-
{{todo|wish|Описание пожелания — ~~~~|done|Исправлено — ~~~~}}
+
{{todo|wish|Описание пожелания (~~~~):
-
|}
+
* сделать первое
 +
* сделать второе
 +
* сделать третье
 +
|done|Сделано ~~~~}}
 +
{{todo|impr|Описание обновления/улучшения — ~~~~}}
 +
{{TodoEndList}}
</pre>
</pre>
'''Результат:'''
'''Результат:'''
-
{|
+
{{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)}}
-
{{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
{{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)}}
-
{{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
{{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)}}
-
{{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
{{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)|done}}
-
{{todo|bug|Описание ошибки — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Исправлено — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
{{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)|ОК|Исправлено — [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)}}
-
{{todo|warn|Описание предупреждения — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Сделано — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
{{todo|wish|Описание пожелания ([[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)):
-
{{todo|wish|Описание пожелания — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)|done|Сделано — [[Участник:Vokov|К.В.Воронцов]] 11:31, 23 апреля 2008 (MSD)}}
+
* сделать первое
-
|}
+
* сделать второе
 +
* сделать третье
 +
|done|Сделано [[Участник:Vokov|К.В.Воронцов]] 13:06, 23 апреля 2008 (MSD)}}
 +
{{todo|impr|Описание обновления/улучшения — [[Участник:Andrew|Andrew]] 13:27, 26 апреля 2008 (MSD)}}
 +
{{TodoEndList}}
 +
<noinclude>
 +
[[Категория:MachineLearning:Документация шаблонов]]
 +
</noinclude>

Текущая версия

Шаблон предназначен для оформления пунктов в списках сбора требований, например MachineLearning:ToDo.

Параметры шаблона

Первый параметр указывает на тип пункта, сейчас поддерживаются bug, warn, wish.

Второй параметр — основной текст сообщения об ошибке, предупреждения, замечания или требования.

Третий параметр необязателен. Если он указан, это означает, что для данного сообщения есть ответ. Если это слово done, то содержимое сообщения зачёркивается как выполненное.

Четвёртый параметр также необязателен. Это текст ответа на сообщение.

Пример исходной разметки: 

{{todo|bug|Описание ошибки — ~~~~}}
{{todo|warn|Описание предупреждения — ~~~~}}
{{todo|wish|Описание пожелания — ~~~~}}
{{todo|bug|Описание ошибки — ~~~~|done}}
{{todo|warn|Описание предупреждения — ~~~~|ОК|Исправлено — ~~~~}}
{{todo|wish|Описание пожелания (~~~~):
* сделать первое
* сделать второе
* сделать третье
|done|Сделано ~~~~}}
{{todo|impr|Описание обновления/улучшения — ~~~~}}
{{TodoEndList}}

Результат:

Описание ошибки — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Описание предупреждения — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Описание пожелания — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Описание ошибки — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Описание предупреждения — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Исправлено — К.В.Воронцов 13:06, 23 апреля 2008 (MSD)

Описание пожелания (К.В.Воронцов 13:06, 23 апреля 2008 (MSD)):

  • сделать первое
  • сделать второе
  • сделать третье
Сделано К.В.Воронцов 13:06, 23 апреля 2008 (MSD)
Описание обновления/улучшения — Andrew 13:27, 26 апреля 2008 (MSD)
Источник — «http://machinelearning.ru/wiki/index.php?title=%D0%A8%D0%B0%D0%B1%D0%BB%D0%BE%D0%BD:Todo/%D0%94%D0%BE%D0%BA%D1%83%D0%BC%D0%B5%D0%BD%D1%82%D0%B0%D1%86%D0%B8%D1%8F»
Личные инструменты