pgsrc/Help%2FPhpHighlightPlugin

   1 Date: Thu,  9 Dec 2010 17:30:39 +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;
   6   markup=2;
   7   charset=UTF-8
   8 Content-Transfer-Encoding: binary
   9
  10 The **~PhpHighlight** [[Help:WikiPlugin|plugin]] pretty-prints PHP code using the
  11 php-function:highlight-string.
  12
  13 == Usage ==
  14
  15 You specify options for the plugin on the same line as ##~<~<~PhpHighlight##,
  16 and put the code on the following lines, until the final ##~>~>##:
  17
  18 {{{
  19 <<PhpHighlight [wrap?] [color options]
  20 code to be highlighted
  21 >>
  22 }}}
  23
  24 == Description ==
  25
  26 Depending on the ##wrap## option, then the plugin will take care of
  27 adding ##<?php## and ##?>## to the code before passing it to
  28 php-function:highlight-string. If the PHP delimiters were added, then
  29 the plugin removes them again from the highlighted string, before
  30 presenting it.
  31
  32 == Options ==
  33
  34 Automatic Wrapping:
  35
  36   If you don't want the plugin to automatically wrap the source code
  37   in ##<?php## and ##?>##, then set ##wrap## to ##0##. The default value is ##1##
  38   which means that the plugin takes care of adding and removing
  39   ##<?php## and ##?>## automatically.
  40
  41   If you set ##wrap## to ##0##, then you'll be able to mix PHP code with
  42   HTML. The plugin will then translate '##< ?php##' into '##<?php##' and
  43   '##? >##' into '##?>##' to allow you to start and stop PHP mode in your
  44   code.
  45
  46 Color Options:
  47
  48   The plugin accepts optional color arguments which correspond to the
  49   highlight settings in *php.ini*. Specified colors must be a valid
  50   hexadecimal color or
  51   [[http://www.w3.org/TR/REC-html40/types.html#h-6.5|HTML 4 color name]]
  52   in lowercase, such as ##'#0f0344'## or ##blue##. You can set the
  53   following options:
  54
  55   ##string##, ##comment##, ##keyword##, ##bg##, ##default##, and ##html##
  56
  57 == Examples ==
  58
  59 === PHP with default colors from ##php.ini##: ===
  60
  61 <<PhpHighlight
  62 function hello() {
  63     echo "Hello World<p>";
  64 }
  65 >>
  66
  67 === HTML with embedded PHP ===
  68
  69 Here we have to use ##wrap=0## to prevent automatic wrapping, and escape
  70 '##?>##' as '##? >##':
  71
  72 <<PhpHighlight wrap=0 html='#000000' bg='#dddddd'
  73 <html>
  74   <head>
  75     <title>PHP Test</title>
  76   </head>
  77   <body>
  78     < ?php echo "<p>Hello World</p>\n"; ? >
  79   </body>
  80 </html>
  81 >>
  82
  83 === C Source ===
  84
  85 Although ##highlight_string()## was designed with PHP code in mind it is
  86 suitable for basic syntax-highlighting of most C code because the two
  87 syntax are similar.
  88
  89 <<PhpHighlight default=black string=blue comment=gray keyword=purple
  90 #include <stdio.h>
  91 /* Get load */
  92 int
  93 getload(void)
  94 {
  95     if ((fp = fopen("/proc/loadavg", "r")) == NULL) {
  96         syslog(LOG_ERR, _("%s %s: unable to open %s: %s"), _("FATAL ERROR:"),
  97               "getload()", "/proc/loadavg", strerror(errno));
  98         exit(EX_OSFILE);
  99     }
 100     fclose(fp);
 101 }
 102 >>
 103
 104 == Authors ==
 105 * [[mailto:gimpster@gimpster.com|Martin Geisler]]
 106 * [[mailto:carstenklapp@users.sourceforge.net|Carsten Klapp]]
 107
 108 == See Also ==
 109 * [[Help:SyntaxHighlighterPlugin|SyntaxHighlighter]] plugin for highlighting other languages.
 110
 111 <noinclude>
 112 ----
 113 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 114 </noinclude>