DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:codeprettify

Code Prettifier Plugin

Compatible with DokuWiki

  • 2017-02-19 "Frusterick Manners" yes
  • 2016-06-26 "Elenor Of Tsort" yes
  • 2015-08-10 "Detritus" yes
  • 2014-09-29 "Hrun" yes

plugin syntax highlighting of source code snippets in wiki page using google-code-prettify (javascript module with CSS files)

Last updated on
2017-01-19
Provides
Syntax
Repository
Source

Installation

Install the plugin through the Extension Manager or Plugin Manager using the download URL above, which points to latest version of the plugin. Refer to plugin installation instructions.

Note: After updated to 2015-09-12 release, you can remove older “google-code-prettify” subfolder in this plugin directory.

Feature

This plugin enable syntax highlighting of code snippets in your page using Javascript code prettifier (former “google-code-prettify”). This plugin package includes subset of Javascript code prettifier, they are separately licensed under the Apache License, Version 2.0

  • You can configure Code Prettifier plugin to override DokuWiki built-in syntax <code> for code blocks.
  • you may use skin (css file) for code block.

Examples/Usage

  • Enclose code snippets using <Code> and </Code> tag to show it pretty-printed in wiki page.
  • Prettify module makes a best effort to guess the language but works best with C-like and HTML-like languages.
  • To specify language hint for Prettify, you can use
    1) <Code:ext> (file extension, you must put it just after “Code:” keyword) or
    2) <Code lang-ext> option.
  • For example, use <Code:css> or <Code lang-css> to specify that the code is Cascading Style Sheets (CSS).
  • use linenums option to turn on line numbering. To specify start line number, you can add a colon and the number to the end of the option, eg. linenums:12.
  • If you want to add title for code block, you can specify it after | that will be shown just above the code box.
<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

Configuration and Settings

Config key Description
override override DokuWiki built-in syntax <code> for Code Blocks.
url_loader url of prettify loader (default blank)
:!: obsoleted since 2015-09-12 release
url_prettify_handlers Base URL for prettify.js and optional language handler scripts
ex: https://cdn.rawgit.com/google/code-prettify/master/src/
(default blank)
:!: available in 2015-09-12 release
url_prettify_skins Base URL for color theme for code-prettify (css)
ex: https://cdn.rawgit.com/google/code-prettify/master/styles/
(default blank)
:!: available in 2015-09-12 release
lang_handlers additional langage handler (comma separated)
skin color theme/skin for code-prettify (CSS filename in code-prettify/styles/)

Detail information of the Javascript code prettifier is available from:

This plugin package contains some skins those found in Prettify Themes Gallery. You may set one of following css filename in the skin field.

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

Other color themes for Prettify will be found at http://jmblog.github.io/color-themes-for-google-code-prettify/

Development

Change Log from github repository

ToDo/Wish List

FAQ

Non-highlight code block

use <Code:none> or <Code lang-none> to prevent highlight code. Maybe useful to show error log output or console output.

<Code:none>
This is not any kind of code.
</Code>

Known Bugs and Issues

Discussion

plugin/codeprettify.txt · Last modified: 2017-03-04 10:41 by s.sahara