GNOME Bugzilla – Bug 652782
Improvement of the gtksourceview lang documentation
Last modified: 2013-11-24 15:45:45 UTC
Hi the reference documentation to create new language files is a bit outdated. To start with it would be nice to list some of the developers preferences to them. I'm opening this bug report to myself as I plan on doing it myself in the future Here's a list of things that needs to be added, please feel free to add to them: --missing on the reference * class and class disable (comment, string, no-spell-check) * this value for 'original' (or something similar that I saw once to make invalid a replace tag) -- devs preferences * have a main context at the bottom * 2 space indetation * use ref to def.lang * must be LGPL to be accepted * add e-mail for contact of original lang file developer
I totally agree about this.
Created attachment 261302 [details] [review] Doc: some rules for language definition files The list is added in the reference, not the tutorial. The tutorial is read once, after that the people use the reference.
Created attachment 261303 [details] [review] Complete lang-reference documentation - Like <match>, <start> and <end>, the <define-regex> tag can have regex options attributes (e.g. "extended" or "case-sensitive"). - Context classes (string, comment, no-spell-check) - The "original" attribute for a reference context.
Review of attachment 261302 [details] [review]: ::: docs/reference/lang-reference.xml @@ -35,1 +35,2 @@ <refsect1> +<title>Some rules</title> maybe "rules" is a bit too strong. What about "Best practices"? Other than that sure, go ahead
Review of attachment 261303 [details] [review]: looks good
> maybe "rules" is a bit too strong. What about "Best practices"? Yes, it's better. The commits are pushed.