Макрос генерирует ссылку на паспорт материала.
Параметры
Параметр |
Тип |
Значение по умолчанию |
Описание |
Base |
Имя страницы |
Базовая страница для страницы паспорта материала |
|
FilePath |
http-адрес |
/static |
Базовый путь к файлам материалов |
Format |
Строка |
"auto" |
Класс материала. Возможные значения: auto, MpguLecture, CmcLecture, Lecture, Presentation, AltDoc, Illustration, WikipediaArticle, RFC, LinuxBook, Book, HowTo, Kde, SchoolServer, Generic. При использовании значения auto включается мозг, который (на данный момент, последовательным применением захардкоденных регэкспов к имени страницы) определяет, какой формат использовать. Не путать с форматом материала. Если параметр Icon пустой, то ссылка на иконку генерируется как <IconPrefix><Format><IconSuffix> |
Icon |
http-адрес |
"" |
Путь к иконке, используемой в ссылке. В случае, если путь пустой, используются параметры IconPrefix и IconSuffix |
IconPrefix |
http-адрес |
/static/__icons/material_ |
Префикс пути к иконке, используемой в ссылке. Используется при пустом значении параметра Icon |
IconSuffix |
http-адрес |
".png" |
Суффикс пути к иконке, используемой в ссылке. Используется при пустом значении параметра Icon |
Text |
Строка |
title |
Что используется в качестве текста ссылки. Возможные варианты: name, title, origtitle |
Direct |
Флаг |
False |
Если равен True, генерируется ссылка непосредственно файлы материала, иначе на страницу паспорта |
DirectBrain |
Флаг |
True |
Только если включена опция Direct: если равен True, делается попытка найти индексную страницу (или единственный файл в директории), иначе генерируется ссылка на директорию. |
DirectPath |
Строка |
None |
Только если включена опция Direct: пусть до конкретного файла в материале. |
DirectPathDesc |
Строка |
none |
Только если включена опция Direct: комментарий для конкретного файла в материале. |
Примеры использования
Код |
Результат |
Описание |
<<PassportLink(RFC_1855)>> |
Генерируется ссылка на паспорт материала RFC_1855. |
|
<<PassportLink(RFC_1855,Text=name)>> |
Генерируется ссылка на паспорт материала RFC_1855, в качестве текста используется имя материала. |
|
<<PassportLink(AltDocs_backup,Direct=True)>> |
Генерируется ссылка на файлы материала AltDocs_backup. В данном случае должна сгенерироваться ссылка на индексный файл, так как он наличествует в директории. |
|
<<PassportLink(AltDocs_backup,Direct=True,DirectBrain=False)>> |
Генерируется ссылка на файлы материала AltDocs_backup. В данном случае должна сгенерироваться ссылка на директорию, так как принудительно отлючена опция DirectBrain. |
|
<<PassportLink(RFC_1855,Direct=True)>> |
Генерируется ссылка на файлы материала RFC_1855. Не смотря на опцию DirectBrain, включенную по умолчанию, ссылка генерируется на директорию, так как индексный файл не найден. |
|
<<PassportLink(RFC_1855,Format=Lecture)>> |
Генерируется ссылка на паспорт материала RFC_1855, формат задан принудительно. |
|
<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html)>> |
Генерируется ссылка на файл ch02s11.html материала AltDocs_linuxnovice. |
|
<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html,DirectPathDesc=Emacs для начинающих)>> |
Linux и UNIX: Руководство начинающего пользователя: Emacs для начинающих |
Генерируется ссылка на файл ch02s11.html материала AltDocs_linuxnovice с описанием «Emacs для начинающих». |