Разработки          Услуги          О компании          Контакты  

Правила использования шаблона ContextBox

Материал из биософт-м

Перейти к: навигация, поиск

Контекстный бокс появляется по команде из статьи. Его содержимое определяется категорией данной статьи. Категория вносит в бокс список своих статей в виде краткого оглавления. Получается, что рядом со статьей оглавление связанных с ней статей.

Если у статьи нет своего контекстного бокса то он подставляется согласно правилам описанным в Автоматический контекстный бокс наследуется по иерархии.

Простановка бокса в статье

Для того чтобы бокс появился достаточно в самом начале статьи вставить в нее категорию в фигурных скобках (обычно категории ставятся в квадратных):

 {{Category:Xxxxxxxx}}

Такая категория должна быть заранее оснащена шаблоном ContextBox который описан ниже. Нельзя просто так вставлять в фигурных скобках не подготовленные с помошью ContextBox категории!

Адрес статьи в фигурных скобках означает что содержимое этой статьи нужно вставить в текущую. Соответственно если категория оформлена как контекстный бокс то такая запись приведет к ее вставке в виде бокса в статью. (Естественно текст не подготовленной как описано ниже категории будет тупо вставлен в начало статьи без всякого полезного эффекта).

Авторам статей не занимающихся структуризацией сайта понимать остальное описание не обязательно. Достаточно только понимать что за надпись в фигурных скобках написана в начале статьи и какой от нее эффект.

Управление видом бокса

Это только для продвинутых редакторов.

Если статья принципиально входит в две категории то можно вставить боксы обоих. Но оба бокса потянут за собой шлейф родительских боксов. В итоге где начинается второй бокс будет найти не возможно.

В этом случае бокс первой категории вставляем без его родительских боксов. А бокс второй - полностью.

 {{Category:Xxxxxxxx|Parents=none}}
 {{Category:Yyyyyyyy}}

Эта ситуация - редкий случай. Не надо запутывать контекстный бокс без острой нужды!

Как оснастить категорию баром

Это описание только для администраторов и тех продвинутых авторов, кто решил научится самостоятельно создать новые боксы к группам своих статей.

Группа статей - это категория. Можно просто проставить статьи в категорию упомянув ее во всех статьях в квадратных скобках. Для навигации по статьям тогда надо будет заходить на страницу категории. Никакого навигационного бара при таком применении категорий не появляется.

Когда категорию нужно оснастить способностью быть контекстным баром содержимое текста категории должно быть представлено строго в специальном синтаксисе, состоявшем из шаблона Template:ContextBox за которым следует секция <noinclude>.

Не надо пытаться понять каким образом Template:ContextBox форматирует текст в виде бара, нужно только точно следовать правилам его использования.

Превращать категорию в барную нужно оформив ее текст по следующему единственному разрешенному эталону который теперь вписывается а каждую категорию автоматически:


 “ 

{{ContextBox
|Knot={{{Knot|}}}
|Hide={{{Hide|}}}
|Mode={{{Mode|}}}
|Tree={{{Tree|}}}

|ReplaceTitleNO=
|BoxText=

Пишите тут содержимое бокса для данной категории отделенное сверху
и с низу по одной пустой строке. Обычно содержит список статей
с сокращенными названиями:
* [[Моя вводная статья|Введение]]
* [[Чем замечательна разработка xxxx|Преимущества]]
* [[Результаты внедрения xxxx|Выводы]]
* [[Буги данной xxxx технологии|Дефекты]]

{{Category:Родительская категория|Knot=1|Hide={{{Parents|}}}|Tree={{{Tree|}}}}}
|ContextBottom=
}}
<noinclude>

[[Category:Родительская категория]]
[[Category:Другие категории куда мы еще относимся]]

Здесь пишите краткое описание данной категории которое
будет видно на странице категории но не войдет в бокс.
Естественно это более подробный текст, нежеле в боксе
но это и не полномасштабная статья.
Краткое введение и ссылки на основные статьи категории.
Ссылку на главную статью по теме следует выделить первой
и в ней дать развернутый текст по предмету, охватываемому
данной категорией.

</noinclude>

Выполните точно последовательность действий:

Откройте редактор текста страницы категории

нажав закладку [править]. Не нажимайте кнопок [Править] для раздела! Сейчас нужно будет заменить текст всей категории а не одного ее параграфа. Внимательно!

Удалите все содержимое текста категории

если она уже имеет описание.

Скопируйте эталон

приведенный в боксе выше в текст категории.

Убедитесь что

перед первым словом {{ContextBox нет ни пустых строк ни пробелов. Проверьте что после завершающего </noinclude> нет ни пробелов ни пустых строк.

Вставьте

  • содержимое для бокса после |BoxText=
  • описание категории после <noinclude>

следуя приведенным в эталоне рекомендациям и примерам (потом сами рекомендации сотрите)

Перепроверьте

Что везде где в эталоне пустая строка у вас тоже есть одна пустая строка. Перепроверьте что не налепили лишних пробелов вокруг управляющих команд выделенных красным. И что не удалили ни одного их фрагмента.

Перепроверьте

Все еще раз, еще внимательней! Если нарушите хотя бы мельчайшую деталь - порушите весь сайт! Система хрупкая и не дуракаустойчивая!

Параметры бокса

В эталоне присутствуют несколько параметров, описывающих бокс. Параметры должны быть указаны строго по этой инструкции без лишних пробелов и пустых строк.

|ReplaceTitle=

Если хотите заменить заголовок бокса на иное нежели название категории то сотрите буквы NO перед знаком равенства и впишите краткий залоголовок за знаком равенства. Заголовок не должен слишком отличатся от реального названия категории чтобы не сбить всех с толку напроч.

По умолчанию в заголовке название категории. Это практически всегда именно то что нужно и понятно. Названия категорий всегда обязательно краткие и хорошо идут в заголовок.

Перенос строк и теги Вики в названии запрещены.

Не обязательный параметр. Если не задаете его оставьте текст |ReplaceTitleNO= как есть без изменений (пустота после знака равенства). Категорически запрещается удалять не обязательные параметры даже если они не используются!

|BoxText=

После этого параметра всегда следует одна пустая строка. В след за ней текст, который будет отображен в боксе. Этот текст должен быть краткий по ширине. Это как правило список статей категории в логическом порядке. От вводной, к детальным, и завершая статьями о финальных результатах.

Указывайте сокращенные названия статей вместо длинных (см. как в примере в эталоне вертикальной чертой задано краткое название для длинных статей).

Не словоблудствуйте, ни какого спама, рекламы, это постоянно висящее аккуратное навигационное оглавление а не описательная статья.

Разрешено (и рекомендуется) вставлять маленькие картинки относящиеся к категории или отдельным статьям.

Стиль

Список кратких статей оформляем

  • списком
  • со
  • звездочками

Подзаголовки пишем обычным текстом. (не надо использовать настоящие заголовки вики внутри бокса)

Для ленивых: можно автоматически создать список всех статей категории написав:

  {{#ask: [[Category:Название этой категории]] [[:+]]
  |format=ul
  }}

Где format=ul означает, что названия всех статей надо вывести типовым списком со звездочками. Эта халтура приведет к тому что все названия будут вписаны целиком раздувая бокс и в не логичном порядке. Чисто как временная мера.

{{{{Category:...|Knot=1|Hide=...

Данная запись рекурсивно образует ниже текста бокс следующей категории которая выше уровнем. (То есть визуально категории уровнем выше следуют ниже в рамках бара)

Укажите название категории чей бокс будет следовать за боксом данной категории. Это та категория в которую логически входит данная. Учтите, что данная запись не заносит редактируемую категорию в указанную. Как правило это необходимо, и такое занесение выполняется в разделе <noinclude>.

Не в коем случае не повредите окончание |Knot=1|Hide=... следующее в эталоне за именем родительской категории! Синтаксически это все одна строка в двойных фигурных скобках (на экране она может быть автоматически перенесена).

Обратите внимание, что категория вставляется с помощью фигурных скобок, а не ассоциируется с помощью квадратных.

Этот элемент обязательный, за исключением категории самого верхнего уровня. Ее создаст администратор.

|ContextBottom=

Запрещено трогать этот параметр. Ничего не писать после знака равно, оставить его как в эталоне.

|Knot=, |Hide=, |Mode=, |Tree=

Это мистические параметры которые понятны только админу. Не трогать в них что скопировано с эталона!

<noinclude> ... </noinclude>

Это не параметры шаблона контекстного бокса, но обязательная и неотъемлемая часть эталонного синтаксиса текста категории. Между данными маркерами пишется краткий текст категории который попадет не в бокс а на страницу категории. Ссылки там сокращать не надо. Но и длинных многостраничных трактатов писать нельзя.

Начните текст описания категории со ссылки на основную пиарную статью по данной теме.

Перед текстом (но после <noinclude>!) проставьте категории, к которым относится данная. (Благодаря <noinclude> они не заразят все задачи ниже по дереву через включение категории как бара на всех страницах.)

Пример в эталоне проставляет категории
[[Category:Родительская категория]]
[[Category:Другие категории куда мы еще относимся]]

Сотрите их! Они для примера. Замените на имя той же родительской категории что написали чуть выше в фигурных скобках. Дополнительные категории вписывайте только по мере надобности.

Категории здесь проставляются как обычно - в квадратных скобках, а не как выше, где текст категории вставлялся фигурными скобками в качестве компонента бокса.

Сквозные категории

Тема для интенсивно продвинутых админов способных понять макро проблему и перспективы семантических запросов. Остальным не вникать и не применять.

Между }} и <noinclude> в эталоне можно вписать категории которые каскадно облепят все темы и подкатегории и темы этих подкатегорий, короче все дерево статей которые входят в данную категорию.

Это эквивалент поля Product в системе управления задачами Inwix. Потребность в такой функциональности еще не определена, не используйте ее если не понимаете в точности чего хотите достичь этим.

www.biosoft-m.ru



Просмотры
Личные инструменты