~funderscoreblog cgit wikiget in touch

Создание HTML-версии (выгрузка) содержимого вики

Contents

  1. Создание HTML-версии (выгрузка) содержимого вики
    1. Пример
    2. Пример с использованиемрегулярного выражения в качестве значения параметра --page
    3. Генерируемые файлы
    4. Копирование файлов темы (CSS и изображений)
    5. Известные ограничения

moin export dump — утилита для экспорта HTML-версий вики-страниц в целях создания HTML-версий содержимого вики.

(!) Возможно сгенерировать HTML-версию для всей вики, отдельной страницы или страниц, имена которых удовлетворяют регулярному выражению.

Пример

Для выполнения выгрузки содержимого вики при помощи команды moin export dump необходимо воспользоваться командной строкой для вызова программы moin. Обратные слэши в конце строк в примере ниже предназначены для интерпретации многострочной команды как одной. Если используемый интерпретатор командной строки не поддерживает обработку символов line continuation, то можно набрать приведённый ниже пример в одну строку. 

moin --config-dir=/mywiki \
     --wiki-url=www.myorg.org/mywiki/ \
     export dump \
     --page=ВикиПесочница \
     --target-dir=/home/myname/outputdir \
     --username=ИмяПользователя

Параметр --config-dir является обязательным и должен указывать на каталог с конфигурацией вики (файлом wikiconfig.py).

Параметр --wiki-url является обязательным и должен содержать URL, по которому доступен данный экземпляр вики.

Параметры export dump указывают исполняемую команду (скрипт dump.py в подкаталоге export).

Параметр --page является необязательным и указывает набор страниц, которые должны быть выгружены --- они должы удовлетворять указанному имени страницы. В качестве значения можно также передать регулярное выражение для выгрузки множества страниц, имя которых удовлетворяет ему. Если данный параметр опущен, то будет выгружена вся вики, исключая страницы underlay.

Параметр --target-dir определяет каталог для выгрузки и является обязательным.

Параметр --username является необязательным. При испольовании данного параметра возможность выгрузки определяется доступностью на чтение этой стрпницы данному пользователю. Если данный параметр опущен, то будут выгружены только те страницы, которе доступны на чтение любому.

Важно отметить, что параметры --page, --target-dir и --username могут быть указаны только после параметров export dump, так как являются параметрами, специфичными для данной команды.

Пример с использованиемрегулярного выражения в качестве значения параметра --page

Рассматриваемый в данном разделе пример экспортирует все страницы, имя которых начинается со следующих путей: 

   python /путь/к/библиотекам/python/site-packages/MoinMoin/script/moin.py \
                  --config-dir=/путь/к/конфигурации/экземпляра/вики/ \
                  --wiki-url=http://www.myorg.org/mywiki/ \
                  export dump \
                  --page "Шаблоны/Документация/(РуководстоПоCss|РуководствоПоHtml|РуководствоПоШаблонам).*" \
                  --target-dir=/путь/к/каталогу/для/выгрузки/

Генерируемые файлы

В директории, указанной для сохранения экспортируемых файлов, будут созданы HTML-страницы, соответствующие экспортируемым страницам вики (с учётом регулярного выражения, указанного в параметре --page и спискам доступа).

Файл index.html будет соответствовать главной странице вики или первой странице в списке, построенном на основании значения параметра --page, если таковой указан. Будет создан каталог attachments, куда будут скопированы файлы, прикреплённые страницам. Также будет создан файл error.log ,содержащий отчёт о процессе работы команды.

Если параметр --page не был передан, будут созданы файлы TitleIndex.html и WordIndex.html с оглавлением и словарным индексом, соответственно, по аналогии со страницами АлфавитныйУказатель и ПредметныйУказатель, соответственно.

Копирование файлов темы (CSS и изображений)

Экспортируемые страницы содержат ссылки на изображения и стили, указанные в теме вики по умолчанию. Для того, чтобы данные файлы могли быть использованы при показе экспортированных страниц, их необходимо скопировать в директорию экспорта из каталога со статическими файлами (каталога htdocs), используемыми экземпляром вики. Например, если по умлочанию используется тема modern и каталог, указанный в параметре --target-dir, имеет имя wikiexport, то итоговая структура каталогов должна выглядеть следующим образом: 

  mywikiexport
    attachments
    modern
      css
      img

Известные ограничения