1 Date: Thu, 15 Apr 2010 16:32:58 +0000
2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
4 Content-Type: application/x-phpwiki;
5 pagename=Help%2FPhpHighlightPlugin;
6 flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
9 Content-Transfer-Encoding: binary
11 The **~PhpHighlight** [[Help:WikiPlugin|plugin]] pretty-prints PHP code using the
12 php-function:highlight-string.
14 See also [[Help:SyntaxHighlighterPlugin|SyntaxHighlighter]] plugin for highlighting other languages.
18 You specify options for the plugin on the same line as ##~<~<~PhpHighlight##,
19 and put the code on the following lines, until the final ##~>~>##:
22 <<PhpHighlight [wrap?] [color options]
23 code to be highlighted
29 Depending on the ##wrap## option, then the plugin will take care of
30 adding ##<?php## and ##?>## to the code before passing it to
31 php-function:highlight-string. If the PHP delimiters were added, then
32 the plugin removes them again from the highlighted string, before
39 If you don't want the plugin to automatically wrap the source code
40 in ##<?php## and ##?>##, then set ##wrap## to ##0##. The default value is ##1##
41 which means that the plugin takes care of adding and removing
42 ##<?php## and ##?>## automatically.
44 If you set ##wrap## to ##0##, then you'll be able to mix PHP code with
45 HTML. The plugin will then translate '##< ?php##' into '##<?php##' and
46 '##? >##' into '##?>##' to allow you to start and stop PHP mode in your
51 The plugin accepts optional color arguments which correspond to the
52 highlight settings in *php.ini*. Specified colors must be a valid
54 [HTML 4 color name|http://www.w3.org/TR/REC-html40/types.html#h-6.5]
55 in lowercase, such as ##'#0f0344'## or ##blue##. You can set the
58 ##string##, ##comment##, ##keyword##, ##bg##, ##default##, and ##html##
62 === PHP with default colors from ##php.ini##:
66 echo "Hello World<p>";
70 === HTML with embedded PHP
72 Here we have to use ##wrap=0## to prevent automatic wrapping, and escape
73 '##?>##' as '##? >##':
75 <<PhpHighlight wrap=0 html='#000000' bg='#dddddd'
78 <title>PHP Test</title>
81 < ?php echo "<p>Hello World</p>\n"; ? >
88 Although ##highlight_string()## was designed with PHP code in mind it is
89 suitable for basic syntax-highlighting of most C code because the two
92 <<PhpHighlight default=black string=blue comment=gray keyword=purple
98 if ((fp = fopen("/proc/loadavg", "r")) == NULL) {
99 syslog(LOG_ERR, _("%s %s: unable to open %s: %s"), _("FATAL ERROR:"),
100 "getload()", "/proc/loadavg", strerror(errno));
109 * [[mailto:gimpster@gimpster.com|Martin Geisler]]
110 * [[mailto:carstenklapp@users.sourceforge.net|Carsten Klapp]]
114 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]