doc/todo/syntax_highlighting.mdwn

   1 There's been a lot of work on contrib syntax highlighting plugins. One should be
   2 picked and added to ikiwiki core.
   3
   4 Ideally, it should support both converting whole source files into wiki
   5 pages, as well as doing syntax highlighting as a preprocessor directive
   6 (which is either passed the text, or reads it from a file).
   7
   8 ## The big list of possibilities
   9
  10 * [[plugins/contrib/highlightcode]] uses [[!cpan Syntax::Highlight::Engine::Kate]],
  11   operates on whole source files only, has a few bugs (see
  12   [here](http://u32.net/Highlight_Code_Plugin/), and needs to be updated to
  13   support [[bugs/multiple_pages_with_same_name]].
  14 * [[!cpan IkiWiki-Plugin-syntax]] only operates as a directive.
  15   Interestingly, it supports multiple highlighting backends, including Kate
  16   and Vim.
  17 * [[plugins/contrib/syntax]] only operates as a directive
  18   ([[not_on_source_code_files|automatic_use_of_syntax_plugin_on_source_code_files]]),
  19   and uses [[!cpan Text::VimColor]].
  20 * [[plugins/contrib/sourcehighlight]] uses src-highlight, and operates on
  21   whole source files only. Needs to be updated to
  22   support [[bugs/multiple_pages_with_same_name]].
  23 * [[sourcecode|todo/automatic_use_of_syntax_plugin_on_source_code_files/discussion]]
  24   also uses src-highlight, and operates on whole source files.
  25   Updated to work with the fix for [[bugs/multiple_pages_with_same_name]].  Untested with files with no extension, e.g. `Makefile`.
  26 * [[users/jasonblevins]]'s code plugin uses src-highlight, and supports both
  27   while file and directive use.
  28
  29 * [hlsimple](http://pivot.cs.unb.ca/git/?p=ikiplugins.git;a=blob_plain;f=IkiWiki/Plugin/hlsimple.pm;hb=HEAD) is a wrapper for the the perl module Syntax::Highlight::Engine::Simple.  This is pure perl, pretty simple, uses css. It ought to be pretty fast (according to the author, and just because it is not external).
  30 On the other hand, there are not many predefined languages yet.  Defining language syntaxes is about as much
  31 work as source-highlight, but in perl.  I plan to package the base module for debian. Perhaps after the author
  32 releases the 5 or 6 language definitions he has running on his web site, it might be suitable for inclusion in ikiwiki. [[DavidBremner]]
  33
  34 ## General problems
  35
  36 * Using non-perl syntax highlighting backends is slow. I'd prefer either
  37   using a perl module, or a multiple-backend solution that can use a perl
  38   module as one option. (Or, if there's a great highlighter python module,
  39   we could use an external plugin..)
  40 * Currently no single plugin supports both modes of operation (directive
  41   and whole source file to page).
  42
  43   > This is now fixed by the [[ikiwiki/directive/format]] directive for all
  44   > whole-source-file plugins, right?
  45
  46 * Nothing seems to support
  47   [[wiki-formatted_comments|wiki-formatted_comments_with_syntax_plugin]]
  48   inside source files. Doing this probably means post-processing the
  49   results of the highlighting engine, to find places where it's highlighted
  50   comments, and then running them through the ikiwiki rendering pipeline.
  51   This seems fairly doable with [[!cpan Syntax::Highlight::Engine::Kate]],
  52   at least.
  53 * The whole-file plugins tend to have a problem that things that look like
  54   wikilinks in the source code get munged into links by ikiwiki, which can
  55   have confusing results. Similar problem with preprocessor directives.
  56   One approach that's also been requested for eg,
  57   [[plugins/contrib/mediawiki]] is to allow controlling which linkification
  58   types a page type can have on it.
  59
  60   > The previous two points seem to be related.  One thought: instead of
  61   > getting the source from the `content` parameter, the plugin could
  62   > re-load the page source.  That would stop directives/links from
  63   > being processed in the source.  As noted above, comments
  64   > could then be parsed for directives/links later.
  65   >
  66   > Would it be worth adding a `nodirectives` option when registering
  67   > an htmlize hook that switches off directive and link processing before
  68   > generating the html for a page?
  69
  70 * The whole-file plugins all get confused if there is a `foo.c` and a `foo.h`.
  71   This is trivially fixable now by passing the keepextension option when
  72   registering the htmlize hooks, though.
  73 * Whole-file plugins register a bunch of htmlize hooks. The wacky thing
  74   about it is that, when creating a new page, you can then pick "c" or
  75   "h" or "pl" etc from the dropdown that normally has "mdwn" etc in it.
  76   Is this a bug, or a feature? (Even if a feature, plugins with many
  77   extensions make the dropdown unusable.. One way to deal with that is have
  78   a config setting that lists what extensions to offer highlighting for.
  79   Most people won't need/want the dozens some engines support.)
  80 * The per page highlighters can't handle creating wiki pages from
  81   "Makefile", or other files without a significant extension.
  82   Not clear how to fix this, as ikiwiki is very oriented toward file
  83   extensions. The workaround is to use a directive on a wiki page, pulling
  84   in the Makefile.
  85
  86   > I wonder how hard it would be to make a patch whereby a file with
  87   > no `.` in the name, and a name that matches a filetype, and where
  88   > that filetype was registered `keepextension`, then the file is just
  89   > chosen as the appropriate type.  This would allow `Makefile` to
  90   > work.
  91
  92 like this:
  93
  94     diff --git a/IkiWiki.pm b/IkiWiki.pm
  95     index 8d728c9..1bd46a9 100644
  96     --- a/IkiWiki.pm
  97     +++ b/IkiWiki.pm
  98     @@ -618,6 +618,8 @@ sub pagetype ($) {
  99
 100         if ($page =~ /\.([^.]+)$/) {
 101                 return $1 if exists $hooks{htmlize}{$1};
 102     +   } elsif ($hooks{htmlize}{$page}{keepextension}) {
 103     +           return $page;
 104         }
 105         return;
 106      }
 107
 108 ## format directive
 109
 110 Rather than making syntax highlight plugins have to provide a preprocessor
 111 directive as well as handling whole source files, perhaps a generic format
 112 directive could be used:
 113
 114         \[[!format pl """..."""]]
 115
 116 That would run the text through the pl htmlizer, from the syntax hightligh
 117 plugin. OTOH, if "rst" were given, it would run the text through the rst
 118 htmlizer. So, more generic, allows mixing different types of markup on one
 119 page, as well as syntax highlighting. Does require specifying the type of
 120 format, instead of allowing it to be guessed (which some syntax highlighters
 121 can do). (This directive is now implemented..)
 122
 123 Hmm, this would also allow comments inside source files to have mdwn
 124 embedded in them, without making the use of mdwn a special case, or needing
 125 to postprocess the syntax highlighter output to find comments.
 126
 127         /* \[[!format mdwn """
 128
 129         This is a comment in my C file. You can use mdwn in here.
 130
 131         """]] */
 132
 133 Note that this assumes that directives are expanded in source files.