summaryrefslogtreecommitdiffstats
path: root/paste/include/geshi/scripts/get-keywords/docs/README
diff options
context:
space:
mode:
Diffstat (limited to 'paste/include/geshi/scripts/get-keywords/docs/README')
-rw-r--r--paste/include/geshi/scripts/get-keywords/docs/README23
1 files changed, 23 insertions, 0 deletions
diff --git a/paste/include/geshi/scripts/get-keywords/docs/README b/paste/include/geshi/scripts/get-keywords/docs/README
new file mode 100644
index 0000000..ad60041
--- /dev/null
+++ b/paste/include/geshi/scripts/get-keywords/docs/README
@@ -0,0 +1,23 @@
+get-keywords.php is a script to get a current list of all the keywords for a particular language.
+
+Currently it's very alpha, just like the rest of this stuff. I run Debian and KDE, and so I have
+access to the katepart XML files in /usr/share/apps/katepart/syntax. Thus, the keyword getter
+strategies that use parser those files work for me.
+
+If you know where these files are online, feel free to write a strategy implementation that gets
+the file from the 'net and uses that (perhaps from KDE SVN?).
+
+No real documentation I'm afraid... just look through the code and look at how the various keyword
+strategy stuff is implemented in language/*/class.*getterstrategy.php.
+
+Oh, and to use:
+
+php get-keywords.php [lang] [group[
+php get-keywords.php --list-langs
+php get-keywords.php --list-groups [language]
+
+In the future:
+
+php get-keywords.php ... --output-format=[HTML|text|special]
+
+ $Id: README,v 1.2 2005/06/09 13:31:35 oracleshinoda Exp $