Документация в Траке¶
Создание и имена страниц¶
Трак позволяет создавать свои странички. Для этого используется "движок" Wiki, о котором можно почитать тут:ru.wikipedia.org/wiki/Wiki.
*Веб-адрес *вики-странички с названием DiTrac/AboutDoc в нашем случае выглядит так:
http://support.digispot.ru/trac/wiki/DiTrac/AboutDoc
Для создания новой странички достаточно набрать в адресной строке браузера адрес новой странички. Если такой странички нет, то Трак предложит ее создать. Название странички изменить после создания очень сложно, поэтому необходимо сразу указать его правильно.
Имя страницы должно подчиняться следующим правилам:
* Содержать только латиницу и цифры, начинаться с заглавной буквы
* Использовать для разделения слов* ВерблюжийРегистр* (CamelCase). Это когда каждое слово с заглавной буквы, как горбы у верблюда.
* Запрещается использовать в названиях страниц знаки пунктуации, скобки и пр. служебные символы
* Для создания иерархически связанных страниц используется символ /
* Например: DiManDigispotIIModulesHotStandby
Крайне рекомендуется использовать такое разделение при создании страниц.
- Не должно быть потерянных страниц - все страницы должны быть связаны ссылками друг на друга.
- Родительская страница должна быть. Т.е. если есть DiManDigispotIIModulesHotStandby, то должны существовать страницы:
DiManDigispotIIModules
DiManDigispotII
DiMan
Даже если вы не готовы заполнить страницы сразу - создайте "рыбу", обязательно с заголовком, чтобы автоматически формируемые оглавления нормально читались.
Полезные ссылки по теме:
Редактирование страниц¶
Редактор появляется при редактировании новой или существующей страницы. Для начала редактирования страницы необходимо нажать кнопку Edit this page в низу справа (видна при наличии права на редктирование).
Редактирование странички происходит в окне-редакторе. Редактор может работать в двух режимах WYSIWIG (наглядном) и TEXTAREA (плоский текст). Переключение режимов происходит в правой части редактора {{Image("swich.jpg","nolink")}}
Наглядный режим (WYSIWYG)¶
В* наглядном режиме* форматирование выполняется при помощи панели инструментов, находящейся над окном. {{Image("panel.jpg","nolink")}}
Самая левая кнопка позволяет выбрать стиль текста. Доступны стили:
* Header 1-6. Это заголовки.
Все содержимое странички должно быть разбито на разделы, у каждого из которых название оформлено стилем заголовка.
Заголовок страницы должен быть стилем Header 1, подзаголовк - Header 2 и т.д.
Использование заголовков позволяет:
* Формировать автоматическое оглавление страницы
* Формировать автоматическое оглавление для множества страниц
* Ссылаться на разделы страницы в пределах страницы и извне
- Code block. Это стиль для оформления текста "как есть". Текст этого стиля не переносится по строкам, отображается моноширинным шрифтом, внутри него не распознаются специальные символы. Удобно для вставки логов, исходный текстов и пр. Выглядит это так:
00000D74 @ 18-06-2009, 20:36:48.132 @ @ ERR_MSG @ 8 @ TCP (Host:192.168.0.2 Port:5310) oper=Connect - WSA err=(WSAECONNREFUSED=10061=274Dh) Connection refused. @ TCP_MANAGER 00000D74 @ 18-06-2009, 20:36:58.085 @ @ ERR_MSG @ 8 @ TCP (Host:192.168.0.2 Port:5310) oper=Connect - WSA err=(WSAECONNREFUSED=10061=274Dh) Connection refused. @ TCP_MANAGER
- Quote. Стиль для цитирования и отображения переписки. Выглядит так:
> У нас Тракт не работает!
> > Что делали?
> Ничего, все само сломалось!!!
> > Точно ничего?
> Нет, все само…как только молния в передатчик ударила - Тракт сам сломался…
Кроме стилей, наглядный режим позволяет:
* Выделять шрифт жирностью (Ctrl+B)
* Менять наклон шрифта (Ctrl-I)
* Подчеркивание (Ctrl-U)
* Использовать моноширинный шрифт. Моноширинный шрифт игнорирует +спецсимволы+
* Использовать -зачеркнутый шрифт-,верхний и нижний индексы
* Удалять все форматирование с фрагмента текста
* Формировать в тексте ссылки
* Формировать
## Нумерованные
## Списки
* Просто
* Списки
- Использовать таблицы с простым и удобным редактором.
| Простая | Таблица | На три колонки |
| Один | Два | Три |
- Разделять текст линией
Плоский текст (TEXTAREA)¶
В это режиме все форматирование отображается в виде специальных символов. По началу кажется жутковатым, но в некоторых случаях гораздо проще и быстрее, чем тыкать мышкой.
Некоторые функции, типа вставки картинок и других макросов, доступны только в этом режиме.
Пример плоского текста - список с примерами форматирования текста, приведенный выше, в плоском тексте выглядит так:
* *Выделять шрифт жирностью* (Ctrl+B)
* _Менять наклон шрифта_ (Ctrl-I)
* +Подчеркивание+ (Ctrl-U)
* Использовать @моноширинный шрифт. Моноширинный шрифт игнорирует +спецсимволы+ @
* Использовать -зачеркнутый шрифт-,^верхний^ и ~нижний~ индексы
* Удалять все форматирование с фрагмента текста
* Формировать в тексте "ссылки":http://trac.edgewall.org/wiki/TranslationRu/TracLinks
* Формировать
## Нумерованные
## Списки
* Просто
*** Списки
* Использовать таблицы с простым и удобным редактором.
|Простая|Таблица|На три колонки|
|Один|Два|Три|
* Разделять текст линией
----Прикрепленные файлы (Attachments)¶
К любой странице можно прикрепить произвольное количество файлов.
Это делается при помощи кнопки Attach file внизу страницы.
На аттачменты можно ссылаться в тексте страниц, приложенные картинки могут отображаться в тексте.
Атачменты можно скачивать со страниц.
В одном окне невозможно одновременное редактирование содержимого страницы и добавления к ней аттачмента. Но это можно сделать параллельно - в одно окне редактируется содержимое, в другом - добавляются аттачменты.
Ссылки¶
Одна из замечательных особенностей Вики для Трака - это возможность формирования ссылок на любый объекты системы. Далее приведены примеры часто используемых ссылок, для каждой ссылки приведен плоский текст, с помощью которого она сформирована.
| [#255 Ссылка на тикет 255] | [#255 Ссылка на тикет 255] |
| [[DiMan | Ссылка на другую вики страницу][wikiDiMan Ссылка на другую вики страницу]]
|
| [Whatsnew_eng.txt Ссылка на аттачмент для просмотра] |
[attachment:Whatsnew_en.txt Ссылка на аттачмент для просмотра]Щелкните по этой и следующей ссылке, чтобы понять разницу в поведении |
| [raw-Whatsnew_eng.txt Ссылка на аттачмент для скачивания] | [raw-attachment:Whatsnew_en.txt Ссылка на аттачмент для скачивания] |
Про всевозможные Трак-ссылки читать тут.
Макросы¶
Макросы - это способ автоматически сформировать чать страницы при помощи вызова специальной функции. Макросы записываются в плоском коде.
Пример макроса, формирующего оглавление странички: [[PageOutline(1-6,Пример оглавления,inline)]] PageOutline(1-6,Пример оглавления,inline)
Пример макроса, отображающего список тикетов.
Все тикеты про Трак. [[TicketQuery(component=trac)]] TicketQuery(component=trac)
Вообще, о всех существующих макросах и их описании, можно узнать при помощи вызова макроса [[MacroList]]
Вот тут как раз такая страничка.
Картинки¶
Картинки добавляются в текст в два этапа. Сначала надо добавить аттачмент с файлом картинки, а потом вставить в текст странички макрос Image, в котором указать имя аттачмента с картинкой (можно и в обратном порядке).
Примеры:
{{Image("photo.jpg")}} |
# просто картинка. |
{{Image("photo.jpg"," 120px")}} |
# картинка шириной 120 точек. Так можно сжимать большие картинки. Щелчок на картинке откроет ее в полном размере |
{{Image("photo.jpg"," right")}} |
# выравнена вправо |
{{Image("photo.jpg"," nolink")}} |
# щелчок на картинке ни к чему не приведет |
{{Image("photo.jpg"," link=http://www.tract.ru")}} |
# щелчок на картинке откроет ссылку www.tract.ru |
{{Image("photo.jpg"," align=right","width=120")}} |
С явным указанием имен параметров |
Вот, например, так:{{Image("tract.png"," link=http://www.tract.ru")}}
{{Image("tract.png"," link=http://www.tract.ru")}}
История¶
Трак позволяет посмотреть историю изменения каждой странички. Это можно седлать при помощи пункта меню History.
{{Image("history.jpg")}}
На версии странички в истории можно ссылаться явно.
Так можно хранить, например, описание поведения старых версий.
Черновики¶
Чтобы история странички содержала только осмысленные шаги ее изменения, просьба - большие странички и странички описания готовить в разделе черновиков.
Черновики должны создаваться как страничка с именем вида Draft/<имя пользователя>/<имя странички>. Посмотреть на черновики можно тут.
После завершения работы с черновиком плоский текст странички копируется и переносится в содержимое основной страницы. Аттачменты так не переносятся, их надо добавлять к основной странице.
Ненужные черновики просьба удалять.
Почтовая нотификация¶
Если вы хотите, чтобы вам приходили почовые уведомления об изменении страницы, то при просмотре страницы щелкните на Wach this в правом верхнем углу.
Если вы хотите получать уведомления об изменении любой из страниц в разделе, то зайдите в [/trac/prefs/announcer в свои настройки] и в окне General Wiki Announcements укажите маску имени страниц (используя * вместо любых символов), которые вам интересны, например, DiMan*.
Почтовый адрес должен быть указан при регистрации, но если хочется получать wiki-нотификацию на другой ящик, то тогда можно указать другой ящик на этом же окне.
Использование в наших целях¶
| Раздел | Ссылка на корневую страницу | Ответственный |
| Описание Digispot II | DiMan Весь (с подразделами) раздел доступен из интернета любому, даже не зарегистрированному пользователю. |
Павел Константинов |
| Описание инсталляций комплексов | DiComplex | Петр Краснощеков |
| Новости | DiMan\News | Екатерина Баранова Павел Контсантинов |
Предлагаю взять за правило - все полезную информацию вносить в Трак.
