From 222fb240c0596a7b82260a4a8c2cd8ce8caf92b4 Mon Sep 17 00:00:00 2001 From: murphy Date: Thu, 25 Dec 2008 03:26:38 +0000 Subject: Added Star Rating draft to repo and etc folder to coderay-lib.tmproj. --- etc/coderay-lib.tmproj | 22 ++++++++++++++-------- etc/highlighter-rating.textile | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 8 deletions(-) create mode 100644 etc/highlighter-rating.textile 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 @@ documents - expanded - name lib regexFolderFilter @@ -30,6 +28,16 @@ filename ../ftp.yaml + + name + etc + regexFolderFilter + !.*/(\.[^/]*|CVS|_darcs|_MTN|\{arch\}|blib|.*~\.nib|.*\.(framework|app|pbproj|pbxproj|xcode(proj)?|bundle|log|aux))$ + selected + + sourceDirectory + + name gem_server @@ -74,7 +82,7 @@ filename ../Rakefile lastUsed - 2008-08-06T18:57:10Z + 2008-12-25T02:53:00Z filename @@ -84,7 +92,7 @@ filename ../diff lastUsed - 2008-09-30T16:57:58Z + 2008-12-25T02:40:10Z filename @@ -104,9 +112,7 @@ filename ../test/scanners/coderay_suite.rb lastUsed - 2008-12-25T01:19:30Z - selected - + 2008-12-25T02:39:14Z filename @@ -118,7 +124,7 @@ filename ../bench/bench.rb lastUsed - 2008-08-04T21:50:12Z + 2008-12-25T02:42:18Z fileHierarchyDrawerWidth 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. + + -- cgit v1.2.1