summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormurphy <murphy@rubychan.de>2008-12-25 03:26:38 +0000
committermurphy <murphy@rubychan.de>2008-12-25 03:26:38 +0000
commit222fb240c0596a7b82260a4a8c2cd8ce8caf92b4 (patch)
tree7a82a3a7906baab5fc816995b459095d3c8da0eb
parent84d08ed441be2ca9f097c7ee2a571f950df961e1 (diff)
downloadcoderay-222fb240c0596a7b82260a4a8c2cd8ce8caf92b4.tar.gz
Added Star Rating draft to repo and etc folder to coderay-lib.tmproj.
-rw-r--r--etc/coderay-lib.tmproj22
-rw-r--r--etc/highlighter-rating.textile39
2 files changed, 53 insertions, 8 deletions
diff --git a/etc/coderay-lib.tmproj b/etc/coderay-lib.tmproj
index 7173916..b21dd0a 100644
--- a/etc/coderay-lib.tmproj
+++ b/etc/coderay-lib.tmproj
@@ -5,8 +5,6 @@
<key>documents</key>
<array>
<dict>
- <key>expanded</key>
- <true/>
<key>name</key>
<string>lib</string>
<key>regexFolderFilter</key>
@@ -32,6 +30,16 @@
</dict>
<dict>
<key>name</key>
+ <string>etc</string>
+ <key>regexFolderFilter</key>
+ <string>!.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle|log|aux))$</string>
+ <key>selected</key>
+ <true/>
+ <key>sourceDirectory</key>
+ <string></string>
+ </dict>
+ <dict>
+ <key>name</key>
<string>gem_server</string>
<key>regexFolderFilter</key>
<string>!.*/(\.[^/]*|CVS|_darcs|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle))$</string>
@@ -74,7 +82,7 @@
<key>filename</key>
<string>../Rakefile</string>
<key>lastUsed</key>
- <date>2008-08-06T18:57:10Z</date>
+ <date>2008-12-25T02:53:00Z</date>
</dict>
<dict>
<key>filename</key>
@@ -84,7 +92,7 @@
<key>filename</key>
<string>../diff</string>
<key>lastUsed</key>
- <date>2008-09-30T16:57:58Z</date>
+ <date>2008-12-25T02:40:10Z</date>
</dict>
<dict>
<key>filename</key>
@@ -104,9 +112,7 @@
<key>filename</key>
<string>../test/scanners/coderay_suite.rb</string>
<key>lastUsed</key>
- <date>2008-12-25T01:19:30Z</date>
- <key>selected</key>
- <true/>
+ <date>2008-12-25T02:39:14Z</date>
</dict>
<dict>
<key>filename</key>
@@ -118,7 +124,7 @@
<key>filename</key>
<string>../bench/bench.rb</string>
<key>lastUsed</key>
- <date>2008-08-04T21:50:12Z</date>
+ <date>2008-12-25T02:42:18Z</date>
</dict>
</array>
<key>fileHierarchyDrawerWidth</key>
diff --git a/etc/highlighter-rating.textile b/etc/highlighter-rating.textile
new file mode 100644
index 0000000..ece3e26
--- /dev/null
+++ b/etc/highlighter-rating.textile
@@ -0,0 +1,39 @@
+h1=. Star Ratings for Syntax Highlighter Language Support (Draft)
+
+p={font-style: italic}. murphy 2008-11-06, updated 2008-12-25
+
+h2. Abstract
+
+A proposal for a simple, 6-level star rating to estimate a syntax highlighters' support of a given language.
+
+h2. Levels
+
+I propose five levels, which can be represented with 0 to 5 out of 5 stars:
+
+|_=. Name |_=. Level |_. Stars |
+|>. No support |=. 0 | ☆☆☆☆☆ |
+|>. Poor support |=. 1 | ★☆☆☆☆ |
+|>. Basic support |=. 2 | ★★☆☆☆ |
+|>. Good support |=. 3 | ★★★☆☆ |
+|>. Very good support |=. 4 | ★★★★☆ |
+|>. Perfect support |=. 5 | ★★★★★ |
+
+h3. Definition
+
+Each rating has an associated support percentage and a short description.
+
+|_<. Name |_. Stars |_>. % |_<. Description |
+| No support | ☆☆☆☆☆ |>. 0 | Missing, broken, or useless. |
+| Poor support | ★☆☆☆☆ |>. 70 | Highlights average code, fails on complex code, hangs up, buggy. |
+| Basic support | ★★☆☆☆ |>. 90 | Good highlighting for typical code, problems with complex code. |
+| Good support | ★★★☆☆ |>. 98 | Solid highlighting for most code, some problems with very complex code. |
+| Very good support | ★★★★☆ |>. 99 | Perfect highlighting even for complex code, only small problems with edge cases. |
+| Perfect support | ★★★★★ |>. 100 | Complete highlighting, can be used as reference. |
+
+h2. Rating Process
+
+The star ratings are defined above. It is completely up to the author of a scanner to rate their work.
+
+However, they should be careful not to overrate a scanner/lexer. Ratings of 2 and up should only be granted for tested code. A rating of 3 should not be given without a review of another person who knows the language very well. A rating of 5 is very rare for complex languages; such scanners should be bug free, feature complete, and absolutely reliable. A rating of 4 is typically the goal for a developer.
+
+