Welcome to CSSDOC
CSSDOC is a convention to comment Cascading Style Sheets (CSS) to help individuals and teams to improve writing/coding/styling/managing CSS files. It is an adoption of the well known JavaDoc / DocBlock based way of commenting source-code. That's putting style, docblocks and tags together.
Because CSS has not such an explicit commanding character then program-source-code that will be compiled or executed later, the scope what is documented differs compared to the programming languages. Anyway, the benefits of using CSSDOC is mutual and will hopefully help to further develop:
- CSS-Authors can use it to beautify their CSS files and to find a convention they can refer to while sharing files with other authors, writers, designers, webapp devs, creative-theme-directors, ... .
- Software developers can use it to provide more comfortable capabilities inside their software for CSS-Authors and vice versa.
- Application and tools can use CSSDOC to gather additional data from CSS files an author has written down.
Next to finding a standard approach and set of tags we are thinking about how this kind of coding standard can be used in tools that will help web stylists and web application projects.
We are coming from the FLOSS Movement (Free/Libre/Open Source Software) and do both: Webdesign and Programming. Sometimes called Front- and Backenddevelopment these days.
As of July 2009, a first conceptual implementation in the Ruby programming language is available. It's been written by Thomas Kadauke and has a first CSSDOC documentation example.
As of November 2008, the Second Public Draft will describe the elements CSSDOC consists of and acts as a reference to a first set of tags that were developed from Summer 2007 to March 2008. It is the second release and some tags are now obsolete, have been renamed or added compared to the First Public Draft. The overall document structure has been reworked and appendices have been added for a faster read and better understanding.
Some People already created some Snippets oder little Extensions / Configurations to Integrate CSSDOC into Editors. We document them on the EditorIntegration Page.
In case you're interested in this project feel free to contact us. Also we'd like to create a standardization process that is both transparent and open to the public. We do believe that even a bad coding standard is better then having none, so that we will not overdo the first specification draft and put in lots of features.
- Tom Klingenberg - Project Manager and Specification Lead (Mainz, Germany)
- Timo Derstappen - Technical Lead (Cologne, Germany)
- Dirk Jesse - Specification, Tests and Features (Dresden, Germany); Author of YAML - Yet Another Multicolumn Layout
You can reach us by joining our mailinglist.
For a complete list of local wiki pages, see TitleIndex.