576d456f3d3f9cf7055663fcc20e96dc8923cbf1
[ikiwiki.git] / 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 We want to 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). But,
7 the [[ikiwiki/directive/format]] directive makes this easy enough to 
8 do if the plugin only supports whole source files. So, syntax plugins
9 do no really need their own preprocessor directive, unless it makes
10 things easier for the user.
11
12 ## The big list of possibilities
13
14 * [[plugins/contrib/highlightcode]] uses [[!cpan Syntax::Highlight::Engine::Kate]],
15   operates on whole source files only, has a few bugs (see
16   [here](http://u32.net/Highlight_Code_Plugin/), and needs to be updated to
17   support [[bugs/multiple_pages_with_same_name]].
18 * [[!cpan IkiWiki-Plugin-syntax]] only operates as a directive.
19   Interestingly, it supports multiple highlighting backends, including Kate
20   and Vim.
21 * [[plugins/contrib/syntax]] only operates as a directive
22   ([[not_on_source_code_files|automatic_use_of_syntax_plugin_on_source_code_files]]),
23   and uses [[!cpan Text::VimColor]].
24 * [[plugins/contrib/sourcehighlight]] uses src-highlight, and operates on
25   whole source files only. Needs to be updated to
26   support [[bugs/multiple_pages_with_same_name]].
27 * [[sourcecode|todo/automatic_use_of_syntax_plugin_on_source_code_files/discussion]]
28   also uses src-highlight, and operates on whole source files.
29   Updated to work with the fix for [[bugs/multiple_pages_with_same_name]].  Untested with files with no extension, e.g. `Makefile`.
30 * [[users/jasonblevins]]'s code plugin uses src-highlight, and supports both
31   while file and directive use.
32
33 * [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 [[!cpan 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).
34 On the other hand, there are not many predefined languages yet.  Defining language syntaxes is about as much 
35 work as source-highlight, but in perl.  I plan to package the base module for debian. Perhaps after the author 
36 releases the 5 or 6 language definitions he has running on his web site, it might be suitable for inclusion in ikiwiki. [[DavidBremner]]
37
38 ## General problems
39
40 * Using non-perl syntax highlighting backends is slow. I'd prefer either
41   using a perl module, or a multiple-backend solution that can use a perl
42   module as one option. (Or, if there's a great highlighter python module,
43   we could use an external plugin..)
44 * Nothing seems to support 
45   [[wiki-formatted_comments|wiki-formatted_comments_with_syntax_plugin]]
46   inside source files. Doing this probably means post-processing the 
47   results of the highlighting engine, to find places where it's highlighted
48   comments, and then running them through the ikiwiki rendering pipeline.
49   This seems fairly doable with [[!cpan Syntax::Highlight::Engine::Kate]],
50   at least.
51 * The whole-file plugins tend to have a problem that things that look like
52   wikilinks in the source code get munged into links by ikiwiki, which can
53   have confusing results. Similar problem with preprocessor directives.
54   One approach that's also been requested for eg,
55   [[plugins/contrib/mediawiki]] is to allow controlling which linkification
56   types a page type can have on it.
57
58   > The previous two points seem to be related.  One thought: instead of
59   > getting the source from the `content` parameter, the plugin could
60   > re-load the page source.  That would stop directives/links from
61   > being processed in the source.  As noted above, comments
62   > could then be parsed for directives/links later.
63   >
64   > Would it be worth adding a `nodirectives` option when registering
65   > an htmlize hook that switches off directive and link processing before
66   > generating the html for a page?
67
68 * The whole-file plugins all get confused if there is a `foo.c` and a `foo.h`.
69   This is trivially fixable now by passing the keepextension option when
70   registering the htmlize hooks, though. That also should handle the
71   case of source files with names that do not contain an extension (ie,
72   "Makefile") -- in this case you just register the while filename
73   in the htmlize hook.
74 * Whole-file plugins register a bunch of htmlize hooks. The wacky thing
75   about it is that, when creating a new page, you can then pick "c" or
76   "h" or "pl" etc from the dropdown that normally has "Markdown" etc in it.
77   Is this a bug, or a feature? Even if a feature, plugins with many
78   extensions make the dropdown unusable.. 
79
80   Perhaps the thing to do here is to use the new `longname` parameter to
81   the format hook, to give them all names that will group together at or
82   near the end of the list. Ie: "Syntax: perl", "Syntax: C", etc.
83
84 ## format directive and comments
85
86 Hmm, the [[ikiwiki/directive/format]] directive would also allow comments
87 inside source files to have mdwn embedded in them, without making the use
88 of mdwn a special case, or needing to postprocess the syntax highlighter
89 output to find comments.
90
91         /* \[[!format mdwn """
92
93         This is a comment in my C file. You can use mdwn in here.
94
95         """]] */
96
97 Note that this assumes that directives are expanded in source files,
98 which has its own set of problems.