Bull Doc

Текст

Текст и разметка

Основное содержимое файла — обычный html. Если используется специальный класс обработки содержимого, то здесь может быть и вики- или любая другая разметка. Имеется несколько конструкций разметки в пространстве имен bdc (от bulldoc).

Изображения и файлы

Чтобы вставить изображение просто положите его рядом с текстом страницы и сошлитесь на него так:

<img src='myimage.jpg'>

или можно класть картинки в папку, например, так:

<img src='images/myimage.jpg'>

Ссылки на другие главы

Можно вставить ссылку на другую главу с помощью конструкции

<bdc:link page='content/text.html'/>

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

Подсветка синтаксиса

По умолчанию используется подсветка синтаксиса GeSHi. Вы можете указать любой из поддерживаемых языков в теге вида <bdc:my_lang> после двоеточия. Например, для PHP подсветка применяется так:

<bdc:php>
... code here ...
</bdc:php>

Выглядеть будет примерно так:

 
class mediaItem
{
  private $fromPath;
  private $toPath;
 
  public function __construct($fileName,$sourceBasePath,$destBasePath)
  {
    $this->fromPath=$fileName;
    $this->toPath=$destBasePath.$this->getRelativePath($fileName,$sourceBasePath);
  }
//--------------------------------------------
  private function getRelativePath($fileName,$sourceBasePath)
  {
    $baseLength=strlen($sourceBasePath);
    $relativePath=substr($fileName,$baseLength);
    return $relativePath;
  }
}

Ключевые слова для предметного указателя

Странице с текстом можно назначить ключевые слова. Эти слова впоследствии будут использованы при автоматическом построении Предметного указателя и при построении индекса для CHM документа.

Ключевые слова задаются с помощью специального тэга:

<bdc:keywords data='установка, настройка' />