Использование встроенных документов окаменелостей

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

Я изучил страницу веб-сайта об управлении проектной документацией. что подтверждает, что я хочу следовать этой технике, но не могу понять, как это сделать.

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

Я пробовал в нескольких местах, ни одно из которых не работало. В настоящее время документ называется %fossil-root%\doc\foo.wiki (я работаю в Windows), где %fossil-root% — это каталог, содержащий _ _FOSSIL__ (слегка искаженное имя файла из-за уценки), но после запуска сервера с fossil ui, когда я указываю браузеру на http://localhost:8080/doc/foo.wiki, окаменелость показывает мне хорошо отформатированную страницу, говорящую, что не может найти index.html. Я создал /doc/index.html, чтобы посмотреть, что произойдет, но это не имело никакого значения.

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


person nurdglaw    schedule 03.07.2013    source источник
comment
Обратите внимание, что вы можете значительно сэкономить на копировании/вставке, извлекая страницы из внутренней вики из командной строки. Вики-справка окаменелостей предоставит вам подробную информацию. Вы можете составить список ископаемых вики, а затем пройтись по каждому из них с экспортом ископаемых вики. Использование цикла (cmd | while do...) в Linux или (для /F %a in ('cmd') do...) в Windows несколько поможет.   -  person carveone    schedule 26.11.2013


Ответы (3)


Если ваш документ находится в %fossil-root%\doc\foo.wiki, вы можете получить к нему доступ по следующему URL-адресу:

http://localhost:8080/doc/trunk/doc/foo.wiki

Этот URL-адрес разбивается следующим образом:

  • http://localhost:8080 — это корневой URL-адрес для доступа к Fossil при запуске fossil ui.
  • /doc сигнализирует о том, что вы хотите получить доступ к встроенной документации
  • /trunk указывает на регистрацию, содержащую документацию, к которой вы хотите получить доступ
  • /doc/foo.wiki — путь документа внутри репозитория

Вместо trunk также можно указать тег, или название ветки, или даже шестнадцатеричный идентификатор чекина.

В используемом вами URL-адресе http://localhost:8080/doc/foo.wiki foo.wiki интерпретируется как имя регистрации, и путь к документу не указан, что логически означает, что Fossil ничего не найдет.

Что касается примера репозитория, содержащего встроенную документацию, главная страница самого веб-сайта Fossil является ярким примером:

https://www.fossil-scm.org/index.html/doc/trunk/www/index.wiki

где

  • https://www.fossil-scm.org/index.html — это корневой URL-адрес Fossil.
  • /doc указывает на запрос встроенной документации
  • /trunk указывает, что мы хотим получить файлы из транка
  • /www/ — это путь к запрошенному файлу внутри репозитория
  • index.wiki — это имя файла внутри репозитория.

Итак, в ветви "trunk" репозитория файл www/index.wiki содержит домашнюю страницу веб-сайта Fossil.

person Martijn    schedule 03.07.2013

Вам просто нужно поместить документацию в каталог %fossil-root%\www\ (или любой другой каталог, находящийся под контролем версий) в вашем репозитории, а затем вы можете, например, добавить следующую строку в раздел главного меню вашего заголовка, чтобы связать его:

html "<a href='$home/doc/trunk/www/foo.wiki'>Documentation</a>\n"

Как я уже сказал, это может быть любой каталог с контролем версий. Чтобы проверить это, выберите любой файл в репозитории, скажем, файл README на верхнем уровне, и перейдите к http://localhost:8080/doc/trunk/README. Вы должны увидеть, как файл README загружается в вашем браузере в текстовом формате. Помещая вики- или html-файлы в определенный каталог, например www, вы упрощаете организацию файлов, которые вы хотите отобразить как документацию, что упрощает создание ссылок на них.

person Community    schedule 03.07.2013
comment
Спасибо! Я думал, что, вероятно, упустил что-то очень очевидное :-( - person nurdglaw; 03.07.2013
comment
Этот ответ неверен: вы вообще не вмешиваетесь, ваш URL просто неполный. Смотрите мой ответ для объяснения. OP может хранить свою документацию в каталоге doc. - person Martijn; 04.07.2013
comment
@Martijn спасибо, что прояснили это. Я удалил ошибочный раздел. - person ; 04.07.2013

http://www.fossil-scm.org/index.html/doc/trunk/www/embeddeddoc.wiki

После ископаемого 1.33 просто подготовьте документ в репозитории. Если файл вики помещается в

/doc/index.wiki

И используйте веб-браузер для настройки -> Администрирование -> Конфигурация. Существует поле "Индексная страница", заполните свой основной index.html. Например:

/doc/trunk/doc/index.wiki

Или, если вам просто нужна выпущенная версия:

/doc/<version>/doc/index.wiki
person Daniel YC Lin    schedule 20.08.2015