Розширення онлайн допомоги

Скрипт он-лайн допомоги тепер (починаючи з версії SPIP 2.1) здатний об’єднувати кілька джерел даних і подавати їх в єдиному образі у вікні, яке з’являється при натисканні на одну з іконок зі знаком питання в адміністративній зоні сайту.

  • Apparu en : SPIP 2.1

Принципи

Глобальна змінна help_server є не просто URL-адресою каталогу он-лайн допомоги, але таблицею таких URL-адрес (проте зворотну сумісність було збережено). Коли довідка запитується мовою «L», SPIP отримує всі сторінки, які називаються «L-aide.html», що існують за адресою, вказаною в цій глобальній змінній, а потім об’єднує ці дані разом. За замовчуванням ця глобальна таблиця має один елемент - http://www.spip.net/aide, що робить можливим повернутися до звичайної поведінки, але тепер також допускає доповнення іншими елементами.

Тому ми можемо зробити визначення в файлі ecrire/mes_options.php [1] для URL(ів), що вказують на ці нові файли довідки.

Приклад

Тут ми додаємо інформацію в персоналізований розділ довідки до глави «Типографські скорочення» в он-лайн допомозі.

-  В каталозі squelettes/ створіть файл uk-aide.html [2] і запишіть до нього наступне:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="uk" lang="uk" dir="ltr">
<head>
<link rel='stylesheet' href='http://www.spip.net/prive/spip_admin.css' type='text/css' />
</head>
<body>
<h2>raccourcis/Типографські скорочення</h2>
<!-- add customised help -->
<h3 class="spip">Мої власні скорочення</h3>
<p style="color:red;">
Це є налаштований пункт довідки про типографські скорочення.
</p>
<p style="color:navy;">
Це є ще один пункт налаштованої допомоги.
</p>
<!-- кінець додання налаштованих пунктів -->
</body>
</html>

-  У файлі mes_options.php визначте URL, вказуючи каталог, що містить цей файл:

// extra URL for where to find the on-line help
$GLOBALS['help_server'][] = url_de_base(1) . 'squelettes/';

-  Тепер в нормальному вікні допомоги натисніть на «Типографські скорочення» в меню зліва, і ви побачите текст он-лайн довідки, який є типовим для spip.net, доповнений (у кінці) нашим налаштованим текстом [3].

Точки входу в меню допомоги

Для того, щоб мати можливість підключити додаткову допомогу, що налаштовується, сторінка допомоги має бути розміченою в одній з секцій у вигляді: <h2>key/menu_title</h2>.

Ось повний список секцій:

Інсталяція SPIP

  • install0/Налаштування доступу
  • install1/Ваш MySQL connection
  • install2/Вибір бази даних
  • install5/Персональна інформація
  • ftp_auth/Аутентифікація по FTP
  • erreur_mysql/Проблема з шаблоном?

Статті

  • raccourcis/Типографські скорочення (SPIP-ярлики)
  • arttitre/Назва, топ-заголовок, підзаголовок
  • artrub/Вибір рубрики
  • artdesc/Короткий опис
  • artchap/Шапка
  • artvirt/Перенаправлення статті
  • arttexte/Текст
  • artdate/Дата
  • artdate_redac/Дата більш ранньої публікації
  • artauteurs/Автори
  • logoart/Логотип статті
  • artstatut/Статуси статті
  • artprop/Відправлення статті

Рубрики

  • rubhier/Ієрархічна структура рубрик
  • rubrub/Створення рубрики
  • rublogo/Логотип рубрики

Новини

  • breves/Новини (стрічка новин)
  • brevesrub/Вибір рубрики
  • breveslien/Посилання
  • brevesstatut/Стан нови
  • breveslogo/Логотип новини

Зображення і документи

  • ins_img/Вставка зображень
  • ins_doc/Додати документи
  • ins_upload/Установка файлів за допомогою FTP або SCP

Ключі

  • mots/Принцип ключів
  • artmots/Використання ключів
  • motsgroupes/Групи ключів

Реферовані сайти

  • reference/Реферування сайтів
  • rubsyn/Синдиковані сайти
  • artsyn/Синдиковані статті
  • confhttpproxy/Використання проксі

Internal messaging

  • messut/Messages between users
  • messpense/Memos
  • messcalen/The calendar
  • messconf/Messaging customisation

Forums follow-up

  • suiviforum/Forums follow-up

Конфігурація сайту

  • confnom/Назва та адреса вашого сайту
  • confart/Зміст статей
  • confdates/Статті з відкладеною датою
  • confforums/Використання форумів
  • confbreves/Система новин
  • confmessagerie/Внутрішні повідомлення
  • confstat/Статистика переглядів
  • confmails/Автоматизована електронна пошта
  • confmoteur/Вбудований пошук [4]

Налаштування інтерфейсу

  • intersimple/Simplified / complete interface [5]
  • cookie/The administration cookie
  • deconnect/Disconnect

Advanced uses

  • artmodif/Articles being modified
  • suivimodif/Tracking versions
  • corrortho/Spell checking [6]
  • previsu/Previewing
  • latex/Mathematical formulae
  • confurl/URL address types

SPIP - a free software

  • licence/Licence and conditions of use

Додання додаткового блоку до лівого меню

Ви можете також вирішити додати додатковий блок до лівого меню у вікні допомоги.
Щоб зробити це, просто додайте елемент <h1> </h1> до вашого файлу L-aide.html:

<body>
<h1>Special customised help</h1>
<h2>block_custom1/Help on this element</h2>
<h3 class="spip">How to use this element</h3>
<p>
Insert an explanatory customised paragraph here.
</p>
<p>
Add another customised help paragraph here.
</p>
<h2>block_custom2/Help about another element</h2>
<h3 class="spip">Usage of the second element</h3>
<p>
Another customised help explanation.
</p>
</body>
 

Наповнення та організація ваших файлів довідки

Якщо ви вважаєте за краще організувати додаткові файли довідки у під-каталозі (наприклад «my_helpfiles/»), ви маєте зробити визначення у вашому файлі «mes_options.php»: $GLOBALS[’help_server’][] = url_de_base(1) . ’squelettes/my_helpfiles/’;

За додатковою інформацією, будь ласка, зверніться до статті #AIDER.

Примітки

[1У контексті плагіна (наприклад, «myplugin»), ми визначили б цей URL в файлі myplugin_options.php file. Наприклад: $GLOBALS[’help_server’][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MYPLUGIN); or if you prefer to store your help files in a particular subdirectory: $GLOBALS[’help_server’][] = url_de_base(1) . str_replace("../", "", _DIR_PLUGIN_MYPLUGIN) . "my_helpfiles/";

[2Для багатомовного використання застосовуйте правильний відповідний код мови: ar-aide.html, en-aide.html, es-aide.html, ...

[3Нагадуємо: щоб побачити зроблені зміни, рекомендується очищати кеш (щоб видалити попередній файл tmp/cache/aide/)

[4відкинуто в spip2

[5відкинуто в spip2

[6відкинуто в spip2

Автор olly Publié le : Mis à jour : 09/12/15

Traductions : عربي, català, English, français, Nederlands, українська