Инструменты пользователя

Инструменты сайта


plugin:codeprettify

CodePrettifier для «ДокуВики»

Подсветка синтаксиса фрагментов исходного кода на вики-странице с использованием google-code-prettify (модуль javascript с файлами CSS).

Этот плагин включает подсветку синтаксиса фрагментов кода на вашей странице с помощью преттификатора кода Javascript (бывший «google-code-prettify»). Этот пакет плагинов включает подмножество преттификаторов кода Javascript, они лицензируются отдельно в соответствии с лицензией Apache, версия 2.0.

Вы можете настроить плагин Code Prettifier, чтобы переопределить встроенный синтаксис «Докувики» <code> для блоков кода. вы можете использовать скин (файл css) для блока кода.

Совместимость

  • Не работает: Требуется PHP 7.0.x или выше!

Монтаж

Используйте менеджер плагинов для установки или…

  1. скачать zip-файл
  2. распаковать его в<dokuwiki>/lib/plugins/
  3. войдите как администратор и измените плагин в менеджере конфигурации

Применение

  • Прикрепите фрагменты кода, используя теги <Code> и </Code>, чтобы они отображались красиво на вики-странице.
  • Модуль Prettify делает все возможное, чтобы угадать язык, но лучше всего работает с C-подобными и HTML -подобными языками.
  • Чтобы указать языковую подсказку для Prettify, вы можете использовать
  • <Code:ext> (расширение файла, вы должны указать его сразу после ключевого слова «Код:»)
  • <Code lang-ext> вариант
  • Например, используйте <Code:css> или , <Code lang-css> чтобы указать, что код представляет собой каскадные таблицы стилей ( CSS ).
  • используйте linenums или nolinenums для включения/выключения нумерации строк. Вы можете добавить двоеточие и число в конце опции, например. linenums:12 указать номер начальной строки.
  • Если вы хотите добавить заголовок для блока кода, вы можете указать его после |того, как он будет отображаться прямо над полем кода.
  • :!: Теги <Code> и </Code> пишутся с Большой буквы.
<Code:php linenums:1 |Example #1 Our first PHP script: //hello.php//>
<html>
  <head>
  <title>PHP Test</title>
 </head>
 <body>
 <?php echo '<p>Hello World</p>'; ?> 
 </body>
</html>
</Code>

Example #1 Our first PHP script: hello.php

<html>
  <head>
  <title>PHP Test</title>
 </head>
 <body>
 <?php echo '<p>Hello World</p>'; ?> 
 </body>
</html>

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

Config key Description
override переопределить встроенный в «Докувики» синтаксис <code> for для блоков кода.
linenums включить нумерацию строк неявно.
url_loader URL загрузчика prettify (по умолчанию пустой)
:!: устарел с выпуска 2015-09-12
url_prettify_handlers Базовый URL-адрес для prettify.js и необязательных сценариев обработчика языка, например: https://cdn.rawgit.com/google/code-prettify/master/src/ (по умолчанию пусто)
:!: доступно в выпуске 2015-09-12.
url_prettify_skins Базовый URL-адрес для цветовой темы для code-prettify (css), например: https://cdn.rawgit.com/google/code-prettify/master/styles/ (по умолчанию пусто)
:!: доступно в версии 2015-09-12.
lang_handlers дополнительный обработчик языка (через запятую)
skin цветовая тема/скин для code-prettify ( имя файла CSS в code-prettify/styles/)

Подробная информация о преттификаторе кода Javascript доступна по адресу:

Этот пакет плагинов содержит некоторые скины, найденные в галерее Prettify Themes. Вы можете установить одно из следующих имен файла css в skin поле.

  • desert.css
  • doxy.css
  • sons-of-obsidian.css
  • sunburst.css

Другие цветовые темы для Prettify можно найти по адресу: http://jmblog.github.io/color-themes-for-google-code-prettify/

Обновление

Для обновления удалите исходную папку lib/plugins/displaywikipage и установите новую версию, как указано выше.

Файл для загрузки

Лицензия

Click here. Это не обязательно, но, пожалуйста, рассмотрите возможность ссылки на эту страницу с вашего сайта, если вам нравится этот продукт.

Только авторизованные участники могут оставлять комментарии.
plugin/codeprettify.txt · Последнее изменение: 2023/08/19 01:04 — 127.0.0.1