updated branch; this is ready for review for inclusion in IkIWiki

[git.ikiwiki.info.git] / doc / plugins / contrib / sourcehighlight.mdwn

diff --git a/doc/plugins/contrib/sourcehighlight.mdwn b/doc/plugins/contrib/sourcehighlight.mdwn
index 2cf0ca5638a75007279fb778af8cb511a5af910f..07ac2086f4cfeca1bf27c810fd19d933ac76d716 100644 (file)
--- a/doc/plugins/contrib/sourcehighlight.mdwn
+++ b/doc/plugins/contrib/sourcehighlight.mdwn
@@ -1,20 +1,30 @@
+[[!template id=plugin name=sourcehighlight core=0 author="[[DavidBremner]]"]]
+

 I noticed several places in the wiki talking about similar ideas, so I decided to put a page here to point to what I am working on.
 
 I noticed several places in the wiki talking about similar ideas, so I decided to put a page here to point to what I am working on.
 

-I have copied otl.pm and am wrapping source-highlight (why this instead of vim highlight, I dunno, I must be a real emacs guy).  You can find more or less the latest 
-version on 
-[my wiki](http://www.cs.unb.ca/~bremner/wiki/software/ikiwiki/sourcehighlight.pm).
+I have implemented a simple wrapper around
+ [source-highlight](http://www.gnu.org/software/src-highlite/).  You can find the latest version in 
+[git](http://pivot.cs.unb.ca/git?p=ikiplugins.git;a=blob_plain;f=IkiWiki/Plugin/sourcehighlight.pm;hb=HEAD).

 You must specify `highlight_lang=>"foo,bar"` in your setup file.
 where foo and bar are the (source-supported) languages you want to
 highlight
 You must specify `highlight_lang=>"foo,bar"` in your setup file.
 where foo and bar are the (source-supported) languages you want to
 highlight

-# Issues
+### Issues
+
+- I would like to have a link to the raw source; using will_render() and then copying the file should work.
+
+> You might also like to look at the [[todo/source_link]] todo. -- [[Will]]
+
+- Is there a way to configure the colors used by source-highlight (other than editing the globally installed "default.style" file)? It would help if I could pass the command arbitrary command-line arguments; then I could configure which config file it's supposed to use. For instance, I'm not a fan of hard-coding the colors into the HTML output. IMHO, css-style formatting should be preferred. All that can be set via the command line ... --Peter
+
+> I don't really have time right now, but it should be easy to add, if you look at how src-lang is handled.  Patches are welcome :-) --[[DavidBremner]]
+
+Note that [[Will]] wrote a plugin that uses source-highlight also. It's
+available
+[[here|todo/automatic_use_of_syntax_plugin_on_source_code_files/discussion]].
+--[[Joey]]

 
 

-- I would like to have a link to the raw source; using will_render() and then copying the file 
-may work. 
-The discussion in [[plugins/contrib/texinfo]] seems relevant.
+To be honest, [[Will]]'s version of this looks more polished.  I will try his 
+plugin and see if it can just replace mine. --[[DavidBremner]]

 
 

-- the common case of foo.c and foo.h breaks
-because they both generate page working/dir/foo. 
-It looks to me like ikiwiki is hardcoded to strip the extension in `pagename()` (IkiWiki.pm).
-This problem with sourcehighlight needs to be fixed before it is very useful.

 
 

-[[DavidBremner]]
+*Updated* Now uses keepextension so multiple extensions should be OK