Descend - Revision history

Parasyte: /* Push Changesets to hgkw */

2010-10-21T07:06:43Z

‎Push Changesets to hgkw

Parasyte at 07:26, 21 October 2009

2009-10-21T07:26:17Z

Parasyte: /* Style Context Reference */

2009-05-24T17:32:02Z

‎Style Context Reference

Parasyte: /* Running Descend */

2009-05-24T17:26:19Z

‎Running Descend

Parasyte: /* Clone the Source Repository */

2009-05-24T17:24:45Z

‎Clone the Source Repository

Parasyte: /* Style Contexts */ spelling

2009-02-07T01:22:33Z

‎Style Contexts: spelling

Parasyte: /* Getting Started */

2009-02-07T01:20:39Z

‎Getting Started

Parasyte: /* Style Context Reference */

2009-02-01T08:29:00Z

‎Style Context Reference

Parasyte: /* Style Context Reference */

2009-02-01T08:24:51Z

‎Style Context Reference

Parasyte: /* Style Context Reference */

2009-02-01T08:22:36Z

‎Style Context Reference

@@ Line 28: / Line 28: @@
 If you have developer access to push changesets to the hgkw repository, use the following command: (Don't forget to commit to your local repository, first!)
-  $ hg push ssh://username_kodewerxhg@nfsn/repos/descend
+  $ hg push ssh://hg@hg.kodewerx.org/repos/descend
 ==Running Descend==

@@ Line 11: / Line 11: @@
 At the minimum, you should configure your Mercurial client with a "username". For hg, add the following to your ~/.hgrc file (or create a new one)
-  [ui]
+ [ui]
-  username = Real Name <email@address.tld>
+ username = Real Name <email@address.tld>
 ==Development==
@@ Line 20: / Line 20: @@
 Create a local repository with the following command:
-  <nowiki>$ hg clone http://hg.kodewerx.org/descend</nowiki>
+ <nowiki>$ hg clone http://hg.kodewerx.org/descend</nowiki>
 This will create a new subdirectory called "descend" containing all of the source code and repository history.
@@ Line 28: / Line 28: @@
 If you have developer access to push changesets to the hgkw repository, use the following command: (Don't forget to commit to your local repository, first!)
-  $ hg push ssh://username_kodewerxhg@nfsn/repos/descend
+ $ hg push ssh://username_kodewerxhg@nfsn/repos/descend
 ==Running Descend==
@@ Line 38: / Line 38: @@
 On Windows, go to Start -> Run, and type:
-  "C:\Program Files\Mozilla Firefox\firefox.exe" --app "path/to/descend"
+ "C:\Program Files\Mozilla Firefox\firefox.exe" --app "path/to/descend"
 Be sure to verify the path the your Firefox installation is correct. You can also create a batch script to do the same thing.
@@ Line 60: / Line 60: @@
 ====Example Style Context====
-  var style = [
+ var style = [
-−
+     {
-          rule: /hello,?\s*world!/g,
+         rule: /hello,?\s*world!/g,
-          class: 'hello-world'
+         class: 'hello-world'
-      },
+     },
-−
+     {
-          rule: [ 'hello', 'world' ],
+         rule: [ 'hello', 'world' ],
-          class: 'hello-world'
+         class: 'hello-world'
-−
+     }
-  ];
+ ];
 ====Style Context Reference====

@@ Line 95: / Line 95: @@
 |-
 ! style="width: 100px;" |''icase''
-|A Boolean value identifying the rule as case-sensitive (true) or case-insensitive (false, default). Only has effect with String ''rule''s.
+|A Boolean value identifying the rule as case-insensitive (true) or case-sensitive (false, default). Only has effect with String ''rule''s.
 |-
 ! style="width: 100px;" |''id''

@@ Line 38: / Line 38: @@
 On Windows, go to Start -> Run, and type:
-   firefox --app "path/to/descend"
+   "C:\Program Files\Mozilla Firefox\firefox.exe" --app "path/to/descend"
-You can also create a batch script to do the same thing.
+Be sure to verify the path the your Firefox installation is correct. You can also create a batch script to do the same thing.
 ==Developer Notes==

@@ Line 20: / Line 20: @@
 Create a local repository with the following command:
-   $ hg clone http://hg.kodewerx.org/descend
+   <nowiki>$ hg clone http://hg.kodewerx.org/descend</nowiki>
 This will create a new subdirectory called "descend" containing all of the source code and repository history.

@@ Line 48: / Line 48: @@
 ===Style Contexts===
-The concept of a "Style Context" is greatly inspired by [http://qbnz.com/highlighter/ GeSHi], which uses "[http://qbnz.com/highlighter/geshi-doc.html#language-files Language Files]" to define to the highlighter engine how text should be styled. Descend uses files similar to GeSHi's Lnaguage Files (called Syntax Contexts) to define syntax.
+The concept of a "Style Context" is greatly inspired by [http://qbnz.com/highlighter/ GeSHi], which uses "[http://qbnz.com/highlighter/geshi-doc.html#language-files Language Files]" to define to the highlighter engine how text should be styled. Descend uses files similar to GeSHi's Language Files (called Syntax Contexts) to define syntax.
 Writing new syntax highlighters should be very simple. See ''[http://hg.kodewerx.org/index.cgi/descend/file/tip/chrome/content/styles/6502.js descend/chrome/content/styles/6502.js]'' for the 6502 style context.

@@ Line 3: / Line 3: @@
 ==Getting Started==
-The Descend source code is available in a [http://www.selenic.com/mercurial/wiki/ Mercurial] repository. Mercurial can be downloaded from [http://www.selenic.com/mercurial/wiki/index.cgi/BinaryPackages]. Windows users may find [http://tortoisehg.sourceforge.net/ TortoiseHG] useful.
+The Descend source code is available in a [http://www.selenic.com/mercurial/wiki/ Mercurial] repository. Mercurial can be downloaded from [http://www.selenic.com/mercurial/wiki/index.cgi/BinaryPackages Selenic]. Windows users may find [http://tortoisehg.sourceforge.net/ TortoiseHG] useful.
-Descend currently does not contain a local copy of XULRunner (and may never have one; It would be best to use a globally available XULRunner). You can use the XULRunner bundled with Firefox 3.x to run XULRunner.
+Descend currently does not contain a local copy of XULRunner (and may never have one; It would be best to use a globally available XULRunner). You can use the XULRunner bundled with Firefox 3.x to run Descend.
 ==Setup Your Mercurial Client==

@@ Line 98: / Line 98: @@
 |-
 ! style="width: 100px;" |''id''
-|A Number representing which remembered match to use for the anchor/link name. Defaults to 0. Only has effect with ''anchor'' or ''link'', and RegExp ''rule''s.
+|A Number representing which remembered match to use for the ''anchor'' or ''link'' name. Defaults to 0. Only has effect with ''anchor'' or ''link'', and RegExp ''rule''s.
 |-
 ! style="width: 100px;" |''link''

@@ Line 79: / Line 79: @@
 Notes for using RegExps:
-Always include the 'g' flag; Only use the 'm' and 'i' flags if you truly need them (eg. using ^ or $ to match the beginning/end of lines, or if your RegExp includes strings that must match case-insensitively!) There is currently no need for the 'y' flag. Use remembering-parentheses sparingly (and only with the 'id' member).
+Always include the 'g' flag; Only use the 'm' and 'i' flags if you truly need them (eg. using ^ or $ to match the beginning/end of lines, or if your RegExp includes strings that must match case-insensitively!) There is currently no need for the 'y' flag. Use remembering-parentheses sparingly (and only with the ''id'' member).
 |-
 ! style="width: 100px;" |''class''
@@ Line 89: / Line 89: @@
 {| cellspacing="0" border="1"
 ! style="width: 100px;" |''anchor''
-|A String which specifies that these matches should be generated as HTML anchors. The String given is used as a prefix for the anchor name attribute.
+|A String which specifies that these matches should be generated as HTML anchors. The String given is used as a prefix for the anchor's 'name' attribute.
 |-
 ! style="width: 100px;" |''delim''
-|An Array containing 1 or 2 Strings that specifies which characters are allowed to appear before [0] and after [1] the rule. An empty String designates that any character is allowed (default). If only one String is specified, it is used for both before and after delimiters. Only has effect with String rules.
+|An Array containing 1 or 2 Strings that specifies which characters are allowed to appear before [0] and after [1] the rule. An empty String designates that any character is allowed (default). If only one String is specified, it is used for both before and after delimiters. Only has effect with String ''rule''s.
 |-
 ! style="width: 100px;" |''icase''
-|A Boolean value identifying the rule as case-sensitive (true) or case-insensitive (false, default). Only has effect with String rules.
+|A Boolean value identifying the rule as case-sensitive (true) or case-insensitive (false, default). Only has effect with String ''rule''s.
 |-
 ! style="width: 100px;" |''id''
-|A Number representing which remembered match to use for the anchor/link name. Defaults to 0. Only has effect with anchor/link and RegExp rules.
+|A Number representing which remembered match to use for the anchor/link name. Defaults to 0. Only has effect with ''anchor'' / ''link'' and RegExp ''rule''s.
 |-
 ! style="width: 100px;" |''link''
-|A String which specifies that these matches should be generated as HTML links. The String given is used as a prefix for the target anchor.
+|A String which specifies that these matches should be generated as HTML links. The String given is used as a prefix for the target ''anchor''.
 |-
 ! style="width: 100px;" |''sub''
-|A sub-context: an Array of Objects containing rules, classes, etc.
+|A sub-context: an Array of Objects containing ''rule''s, ''class''es, etc. The text matching ''rule'' will be recursively styled with this sub-context.
 |}