Project: S2 styles documentation

[foxfirefey]

This category of the wiki is in need of a serious revamp:

http://wiki.dwscoalition.org/notes/Category:S2_CSS

Also, it was based off of Tabula Rasa. It needs to have the S2-wide things and Tabula-Rasa specific things separated, so we can also make guides for Transmogrified and Negatives.

Basically, we want documentation so that a styles designer can look at it and very quickly figure out all the abilities they have from the built-in classes and layout.

If anybody wants to help out with this, let me know! Describe what your areas of relative expertise are, and I can set you going.

Comments

Styles on the wiki

[cesy]

I know pretty much nothing about S2, styles on LJ/DW, or anything like that. I'm okay with HTML and CSS. I'd be quite keen to help.

Do you know if there is anywhere with basic Styles documentation for someone who knows as little as I do?

Re: Styles on the wiki

[foxfirefey]

Good news: This documentation project doesn't really require knowing much in the way of S2 at all. It's pretty much all outward facing.

Basically what needs to be done is you need to go over the output of the styles and document all of the classes and IDs for styled pages. I am finishing up the_style_kit and when I do you will have some handy example pages to help you.

I recommend using Firebug to help you inspect--certainly not necessary, but I have found it to be a very helpful tool.

The current documentation already up gives an indication of the kind of information that should be there, but some of it is probably incomplete or out of date or not well organized. This is the starting page. I'll note one thing--the comment CSS documentation is on the entry page, but it's listed as wanted.

Do you need any wiki guidance?

Re: Styles on the wiki

[cesy]

I think I'm okay on the wiki. I'll have a proper look at it tonight.

Re: Styles on the wiki

[cesy]

I've had a look through those wiki pages and fixed some of the obvious mistakes and out-of-date bits.

Comparing http://wiki.dwscoalition.org/notes/S2_CSS:_High_level_layout_ids_and_classes and http://wiki.dwscoalition.org/notes/S2_CSS:_Archive_pages_ids_and_classes, do all the classes on the Archive page need to be documented the same way as the High-level ones, or is the current level of detail okay?

Do I need to cross-check every single class, or will most of them be correct, and I just need to check the ones with "Warning" labels and other comments?

Re: Styles on the wiki

[afuna]

BTW, the images bit of the documentation are here:

http://baggyeyes.dreamwidth.org/95234.html?thread=144642

Re: Styles on the wiki

[lapistablet]

Ooh, hello, this is interesting - I've been discussing much the same idea with foxfirefey over in dw_styles. Are you still working on this, and if so do you want to co-ordinate efforts?

Re: Styles on the wiki

[cesy]

I'm not working on it at the moment, no - I got stuck, and I've recently been away and then ill. However, I would still be interested in helping. Feel free to PM me if there's anything I can do.

Re: Styles on the wiki

[lapistablet]

I will do! I've been insanely busy the last week or two so I haven't really got my teeth into the Perl side of it yet, but many hands make light work, as they say.

[sophie]

It needs to have the S2-wide things and Tabula-Rasa specific things separated...

Since Tabula Rasa is just another name for the S2 core, it might be a good idea to note that all the publicly available system styles (and most others) will be the same.

(check with the S2 team first, though!)

[foxfirefey]

There *are* some slight differences though, and Zesty I don't think is up to the snuff of the other two--for instance, it doesn't yet have an option to turn off the default styling.

[wekhter]

Would my layout be of any help to people for this sort of thing?

I also had a setup like it for this for Transmogrified but I think I should re-do it as it's messy.

[foxfirefey]

Oh wow, that is really nifty! Maybe you could work with me and we could include those in the_style_kit as well as other places for people to access?

[wekhter]

Put up the style sheets themselves? Or to help with a write-up of all the classes? Because I know that this is a bit bare-bones as is since DW is a bit class-crazy and many of the elements have multiple classes that I couldn't really properly show. (Also they appear to have added a few since I last updated my styles).

I think it makes a nice visual, at any rate.

[afuna]

Jumping in here, but if you have even a vague idea when you last updated your styles, I can look up everything style-related that's changed between then and now, so you don't need to dig through/try to remember if you've seen $x before, or not!

[wekhter]

Thank you very much, but unfortunately, I've no idea when I last updated it... Probably over a month ago or so. Luckily I have it set up so that all elements with a class or id will be marked as such, so I can just search for unmarked classes pretty quickly. :3 I'll be updating soon (I'm in the middle of a virus scan at the moment).

[afuna]

*awe*

[cesy]

Oh wow. That's very neat.