1 Date: Tue, 5 Feb 2013 15:49:31 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
3 Content-Type: application/x-phpwiki;
4 pagename=Help%2FPhpHighlightPlugin;
5 flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
7 Content-Transfer-Encoding: binary
9 The **~PhpHighlight** [[Help:WikiPlugin|plugin]] pretty-prints PHP code using the
10 php-function:highlight-string.
14 You specify options for the plugin on the same line as ##~<~<~PhpHighlight##,
15 and put the code on the following lines, until the final ##~>~>##:
18 <<PhpHighlight [wrap?] [color options]
19 code to be highlighted
25 Depending on the ##wrap## option, then the plugin will take care of
26 adding ##<?php## and ##?>## to the code before passing it to
27 php-function:highlight-string. If the PHP delimiters were added, then
28 the plugin removes them again from the highlighted string, before
33 === Automatic Wrapping ===
35 If you don't want the plugin to automatically wrap the source code
36 in ##<?php## and ##?>##, then set ##wrap## to ##0##. The default value is ##1##
37 which means that the plugin takes care of adding and removing ##<?php## and ##?>## automatically.
39 If you set ##wrap## to ##0##, then you'll be able to mix PHP code with
40 HTML. The plugin will then translate '##< ?php##' into '##<?php##' and
41 '##? >##' into '##?>##' to allow you to start and stop PHP mode in your code.
45 The plugin accepts optional color arguments which correspond to the
46 highlight settings in **php.ini**. Specified colors must be a valid
48 [[http://www.w3.org/TR/REC-html40/types.html#h-6.5|HTML 4 color name]]
49 in lowercase, such as ##'#0f0344'## or ##blue##. You can set the
50 following options: ##string##, ##comment##, ##keyword##, ##bg##, ##default##, and ##html##.
52 **Note:** ##bg## no longer exists in PHP 5.4.
56 === PHP with default colors from ##php.ini##: ===
60 echo "Hello World<p>";
64 === HTML with embedded PHP ===
66 Here we have to use ##wrap=0## to prevent automatic wrapping, and escape
67 '##?>##' as '##? >##':
69 <<PhpHighlight wrap=0 html='#000000' bg='#dddddd'
72 <title>PHP Test</title>
75 < ?php echo "<p>Hello World</p>\n"; ? >
82 Although ##highlight_string()## was designed with PHP code in mind it is
83 suitable for basic syntax-highlighting of most C code because the two
86 <<PhpHighlight default=black string=blue comment=gray keyword=purple
92 if ((fp = fopen("/proc/loadavg", "r")) == NULL) {
93 syslog(LOG_ERR, _("%s %s: unable to open %s: %s"), _("FATAL ERROR:"),
94 "getload()", "/proc/loadavg", strerror(errno));
105 testing~[badworkaround~];
108 will swallow "~[somearray~]"
111 * [[mailto:gimpster@gimpster.com|Martin Geisler]]
112 * [[mailto:carstenklapp@users.sourceforge.net|Carsten Klapp]] (added ability to override colors defined in ##php.ini##)
115 * [[Help:SyntaxHighlighterPlugin|SyntaxHighlighter]] plugin for highlighting other languages.
119 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]