Различия между версиями 2 и 12 (по 10 версиям)
Версия 2 от 2008-08-02 07:49:09
Размер: 2086
Редактор: eSyr
Комментарий:
Версия 12 от 2012-05-26 03:53:07
Размер: 6822
Редактор: eSyr
Комментарий: überpatching
Удаления помечены так. Добавления помечены так.
Строка 7: Строка 7:
|| Icon || http-адрес || `/static/__icons/material.png` || Путь к иконке, используемой в ссылке. В случае, если путь пустой, иконка не используется ||
|| Text || Строка || name || Что используется в качестве текста ссылки. Взможные варианты: name, title, origtitle ||
|| Direct || Флаг || False || Если равен True, генерируется ссылка непосредственно на директорию с файлами материала, иначе на страницу паспорта ||
|| 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-адрес || <<Verbatim("/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: комментарий для конкретного файла в материале. ||
Строка 11: Строка 17:
==== Примеры использования ===== ==== Примеры использования ====
Строка 13: Строка 19:
{{{<<PassportLink(MaterialName)>>}}}
 Генерируется ссылка на паспорт материала MaterialName.

{{{<<PassportLink(MaterialName,Icon=)>>}}}
 Генерируется ссылка без иконки на паспорт материала MaterialName.

{{{<<PassportLink(MaterialName,Text=title)>>}}}
 Генерируется ссылка на паспорт материала MaterialName, в качестве текста используется название материала.

{{{<<PassportLink(MaterialName,Direct=True)>>}}}
 Генерируется ссылка на файлы материала MaterialName.
|| '''Код''' || '''Результат''' || '''Описание''' ||
|| {{{<<PassportLink(RFC_1855)>>}}} || <<PassportLink(RFC_1855)>> || Генерируется ссылка на паспорт материала RFC_1855. ||
|| {{{<<PassportLink(RFC_1855,Text=name)>>}}} || <<PassportLink(RFC_1855,Text=name)>> || Генерируется ссылка на паспорт материала RFC_1855, в качестве текста используется имя материала. ||
|| {{{<<PassportLink(AltDocs_backup,Direct=True)>>}}} || <<PassportLink(AltDocs_backup,Direct=True)>> || Генерируется ссылка на файлы материала !AltDocs_backup. В данном случае должна сгенерироваться ссылка на индексный файл, так как он наличествует в директории. ||
|| {{{<<PassportLink(AltDocs_backup,Direct=True,DirectBrain=False)>>}}} || <<PassportLink(AltDocs_backup,Direct=True,DirectBrain=False)>> || Генерируется ссылка на файлы материала !AltDocs_backup. В данном случае должна сгенерироваться ссылка на директорию, так как принудительно отлючена опция !DirectBrain. ||
|| {{{<<PassportLink(RFC_1855,Direct=True)>>}}} || <<PassportLink(RFC_1855,Direct=True)>> || Генерируется ссылка на файлы материала RFC_1855. Не смотря на опцию !DirectBrain, включенную по умолчанию, ссылка генерируется на директорию, так как индексный файл не найден. ||
|| {{{<<PassportLink(RFC_1855,Format=Lecture)>>}}} || <<PassportLink(RFC_1855,Format=Lecture)>> || Генерируется ссылка на паспорт материала RFC_1855, формат задан принудительно. ||
|| {{{<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html)>>}}} || <<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html)>> || Генерируется ссылка на файл `ch02s11.html` материала !AltDocs_linuxnovice. ||
|| {{{<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html,DirectPathDesc=Emacs для начинающих)>>}}} || <<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html,DirectPathDesc=Emacs для начинающих)>> || Генерируется ссылка на файл `ch02s11.html` материала !AltDocs_linuxnovice с описанием «Emacs для начинающих». ||

Макрос генерирует ссылку на паспорт материала.

Параметры

Параметр

Тип

Значение по умолчанию

Описание

Base

Имя страницы

PspoMaterials

Базовая страница для страницы паспорта материала

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: Netiquette Guidelines

Генерируется ссылка на паспорт материала RFC_1855.

<<PassportLink(RFC_1855,Text=name)>>

 RFC_1855

Генерируется ссылка на паспорт материала 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: Netiquette Guidelines

Генерируется ссылка на файлы материала RFC_1855. Не смотря на опцию DirectBrain, включенную по умолчанию, ссылка генерируется на директорию, так как индексный файл не найден.

<<PassportLink(RFC_1855,Format=Lecture)>>

 RFC 1855: Netiquette Guidelines

Генерируется ссылка на паспорт материала RFC_1855, формат задан принудительно.

<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html)>>

 Linux и UNIX: Руководство начинающего пользователя

Генерируется ссылка на файл ch02s11.html материала AltDocs_linuxnovice.

<<PassportLink(AltDocs_linuxnovice,Direct=True,DirectPath=ch02s11.html,DirectPathDesc=Emacs для начинающих)>>

 Linux и UNIX: Руководство начинающего пользователя: Emacs для начинающих

Генерируется ссылка на файл ch02s11.html материала AltDocs_linuxnovice с описанием «Emacs для начинающих».

eSyr/WikiHack/Macros/PassportLink (последним исправлял пользователь eSyr 2012-05-26 03:53:07)