User-submitted tutorials / How-To's

[Omni]

If you come to a highlighting consensus please post a concise list here please so I can refer back to it.

[Collector]

Companion does not italicized  the comment, but are green.

Highlighting differences are as follows. Troflip's key words are blue and integers a dark red. Brian's are both blue. Brian's strings are green, while Companion uses red. Studio's parentheses and arithmetic operators are dark purple while Companion's are black. Can't say that I am too fond of Companion's strings.

I'd say to start from Studio's, but change the comments to gray. Should the key words and integers be different?

[gumby]

I also think that the Companion highlighting is easier to read.  With that, I'd vote for:

-  Text in single quotes to be red (Said() strings)
-  Text in double-quotes.  (Print statements, includes) - Not sure.
-  Comments to be light green
-  Operators - not sure, purple doesn't come through very well
-  Keywords - blue, like you've got em

However, these are based on my own biases - I'm sure I'd adapt to whatever is decided.  Just putting in syntax highlighting is a major improvement!

[MusicallyInspired]

Indeed, as long as there's something it'd be great. I kinda like the bright-red strings in Companion, though.

[Collector]

I have altered the PHP file to make the comments gray, which makes Studio's much easier to read. I guess that I like gray for comments because most of the things I do have gray comments. It makes it easier to ignore the comments when you want to concentrate on just the code. Brian's comments are so "in-your-face" that it makes it hard to read the code. The red is the one thing I don't like about Companion's because it is rather distracting. Perhaps if it was dimmed down a bit?

I have also started to add categories. This could be one of the best ways to organize the pages. You ca see the main Wiki page for more on this.

[gumby]

Hey, maroon would be fine with me.  Just as long as it's differentiated from doubly-quoted strings.

[Collector]

OK, what I came up with is

* blue for keywords
* dark blue for integers
* green for operators
* red for single quote strings (slightly darker that the bright red of companion)
* orange for double quote strings
* gray for comments

You can play around with different code on the test page to try these colors out, http://sierrahelp.com/SCI/Wiki/index.php?title=Test_page

Once we come to a consensus I will post a list in hex for Omni.

[MusicallyInspired]

Sounds good to me.

[gumby]

Looks good, but for some reason the green operators are throwing me off.  It might just be the green parentheses, I'm not sure.  Would black be a better choice for the parentheses?

[Collector]

Actually, the green comes from the extension author's C++ highlighting. I could change it, but wouldn't it be good to make them standout a bit? One missing closing parenthesis can make code fail. Perhaps a bit darker green?

[Collector]

I changed it to a bit of a darker green so the parentheses don't stand out so much, but is still a bit distinct. In hex:

* blue for keywords - #0000FF
* dark blue for integers - #000099
* dark green for operators - #006633
* red for single quote strings - #CC0033
* orange for double quote strings - #FF6600
* gray for comments - #999999

[gumby]

Actually, the green comes from the extension author's C++ highlighting. I could change it, but wouldn't it be good to make them standout a bit? One missing closing parenthesis can make code fail. Perhaps a bit darker green?

I gotcha.  I wasn't thinking about interactive syntax highlighting, just readability.  I really like the darker green as opposed the lighter green.  What you've got now works for me!

[Collector]

Well, if everyone else agrees, I'll go with this for the Wiki. It isn't too far off from Companion, but I think it is easier to read. I, too dislike anything that stands out too much. It is especially irritating when you have to stare at the same bit for extended periods trying to find where a script is broken. Also, if Omni changes Studio's highlighting to match, I'll redo that tutorial and help file to match.

[MusicallyInspired]

Oh wait, is it possible (if everyone agrees) that you could switch the colours for the single quote strings and double quote strings? Companion's single quote strings are brown and the double quotes are red. I don't mind the darker red and the orange as replacements, but it looks odd to me to have them reversed. Again, if everyone doesn't mind.

[Collector]

I don't mind. I think the main thing is to have the difference. So that would be:

* blue for keywords - #0000FF
* dark blue for integers - #000099
* dark green for operators - #006633
* orange for single quote strings - #FF6600
* red for double quote strings - #CC0033
* gray for comments - #999999