Revision as of 14:32, 25 August 2010

How Do I File a New Bug?

• In Bugzilla, click on New. Select Dreamwidth Development. In Component, select Style System. Enter a Summary and a Description. Mention style and theme names in the summary if needed. If you're adding a style or a color theme, indicate style name, theme name(s), the name of the author and the Dreamscapes submission URL in the description.

• Click on Show Advanced Fields. Set Initial State to ASSIGNED and enter your Bugzilla e-mail address in Assign To.

Where Are Style Files?

• core2.s2 is in ~/dw/cs/dw-free/bin/upgrading/s2layers/

• Theme and layout .s2 files are in ~/dw/cs/dw-free/bin/upgrading/s2layers/LAYERNAME/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/LAYERNAME/

• .pm style files are in ~/dw/cvs/dw-free/cgi-bin/LJ/S2Theme/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/LAYERNAME/

• S2Theme.pm is in ~/dw/cvs/dw-free/cgi-bin/LJ/

• S2Theme_local.pm is in ~/dw/cvs/dw-nonfree/cgi-bin/LJ/

• s2layers.dat is in ~/dw/cs/dw-free/bin/upgrading/

• s2layers-local.dat is in ~/dw/cs/dw-nonfree/bin/upgrading/

Dw-free or dw-nonfree?

• To be usable on the site, third party images must be obtained from a site which allows storage on one's own server, commercial use, and use in website templates. If this isn't the case, images must be replaced or removed from the style/theme.

• If the style is in dw-free, themes which contain images Dreamwidth can use but can't redistribute/sublicense go to dw-nonfree in local files.

• If the style is in dw-nonfree all its themes automatically go there as well. This the case for Transmogrified and Sunday Morning themes for example.

Adding a New Style

Edit s2layers.dat

• If the style goes to dw-nonfree, edit s2layers-local.dat instead.

• If this is a new Core2 layout, add:

stylename/layout          layout          core2
stylename/themes          theme+          stylename/layout

• If this is a child of Tabula Rasa, add:

stylename/layout          layout(core2base/layout)    core2
stylename/themes          theme+                      stylename/layout

Edit S2Theme.pm

• If the default theme goes to dw-nonfree, edit S2Theme_local.pm instead.

• Scroll down to %default_themes and add the style and default theme:

layoutname => 'stylename/defaulttheme',

Create LAYOUTNAME.pm

• Create LAYOUTNAME.pm in ~/dw/cvs/dw-free/cgi-bin/LJ/S2Theme/ or ~/dw/cvs/dw-nonfree/cgi-bin/LJ/S2Theme/.

• Add:

package LJ::S2Theme::layoutname;
use base qw( LJ::S2Theme );
 
sub layouts { ( "1" => "one-column", "2l" => "two-columns-left", "2r" => "two-columns-right", "3" => "three-columns-sides", "3r" => "three-columns-right", "3l" => "three-columns-left" ) }
sub layout_prop { "layout_type" }
 
sub designer { "name" }
 
1;

Remove layout options that don't apply to the style, of course.

Create the LAYOUTNAME directory

• Create a directory with the name of the style in ~/dw/cs/dw-free/bin/upgrading/s2layers/ or ~/dw/cs/dw-nonfree/bin/upgrading/s2layers/.

Create layout.s2

• In the directory you've created, create a file named layout.s2. Add:

layerinfo type = "layout";
layerinfo name = "layoutname";
layerinfo redist_uniq = "layoutname/layout";
layerinfo author_name = "someuser";
layerinfo lang = "en";
 
set layout_authors = [ { "name" => "someuser", "type" => "user" } ];

• Add the style code.

• If the style has custom properties, they should be sorted into existing groups (presentation, colors, fonts, images, modules, text, other) by appending _child to the group name. For example:

propgroup images_child
    property string image_module_list { des = "Module list image"; }

• If a module has more or fewer available positions than other modules, you can customize the sections it can be set to by using _override. For example:

    property string module_navlinks_section_override {
        values = "none|(none)|header|Header|one|Group One|two|Group Two";
        grouped = 1;
        }
 
set grouped_property_override = { "module_navlinks_section" => "module_navlinks_section_override" };
 
set module_navlinks_section = "header";

Of course, you need to make sure it's printed correctly when set to every position, possibly by editing function Page::print() { }.

Check layout.s2

• No tabs or trailing spaces.

• No empty properties (S2 or CSS).

• No hardcoded colors, fonts or text except shadows or :before/:after text/characters.

• No redundant code (S2 or CSS).

• Format CSS to be easily readable and editable. Selectors should be listed in the order they're displayed on the screen, divided into sections thanks to comments, properly indented and spaced out; properties should be listed alphabetically:

    /*--- Entries & Comments ---*/
 
    .entry, .comment {
        margin: 2em .5em;
        padding: 2em;
        }

• Remove leading zeros from decimals (.5em instead of 0.5em).

• Format CSS to use shorthand whenever possible:

        border: 1px solid $*color_module_border;
        border-top: none;
        list-style: square inside url($*image_list_bullet);
        margin: 2em .5em 1em;

instead of:

        border-bottom: 1px solid $*color_module_border;
        border-left: 1px solid $*color_module_border;
        border-right: 1px solid $*color_module_border;
        list-style-image: url($*image_list_bullet);
        list-style-position: inside;
        list-style-type: square;
        margin-bottom: 1em;
        margin-left: .5em;
        margin-right: .5em;
        margin-top: 2em;

• Group selectors whenever possible.

Create themes.s2

• In the directory you've created, create a file named themes.s2.

• If some themes go to dw-nonfree, create themes-local.s2 in dw-nonfree as well.

• Follow the steps outlined in the next section.

Adding a New Color Theme

Edit themes.s2

• If the theme goes to dw-nonfree, edit themes-local.s2 instead.

• Make sure the color theme has the right header. As Afuna explained here in dw_dev_training, it should look like this:

#NEWLAYER: layoutname/themename
layerinfo type = "theme";
layerinfo name = "Theme Name";
layerinfo redist_uniq = "layoutname/themename";
layerinfo author_name = "someuser";

• If the color theme author is not the style author, add this this line below, separated by a blank line:

set layout_authors = [ { "name" => "someuser", "type" => "user" } ];

• If the theme has any images, name them like this: themename_imagename.xxx. Keep the image name used in other themes if there are any.

If there's only one image, give it the theme name: themename.xxx

If the theme has generic images used in other themes, simply use imagename.xxx.

In the theme, use layoutname/themename_imagename.xxx, layoutname/themename.xxx or layoutname/imagename.xxx as the URL.

• If you need to add theme-specific CSS, use:

function Page::print_theme_stylesheet() {
    """
    CSS HERE
    """;
}

• Make sure to add the theme code in the right place (themes should be alphabetically sorted).

Check your theme file

• No tabs or trailing spaces.

• No empty properties (S2 or CSS).

• No hardcoded colors in print_theme_stylesheet() if possible.

• Use shorthand for color codes whenever possible (#555 instead of #555555; #abc instead of #aabbcc).

• Sort properties into categories using these headers:

##===============================
## Page Colors
##===============================

Colors are sorted into three categories: Page Colors, Entry Colors and Module Colors.

Other categories are Images and Fonts.

• Sort properties alphabetically into each category, but put generic properties before specific properties (e.g. color_page_background before color_header_background).

• Format CSS to be easily readable and editable: use indents and spaces, list properties alphabetically, use shorthand whenever possible.

• Each theme file must be separated by two blank lines. Leave one blank line after the last theme in the file.

• If you see another theme which needs editing, create a second patch/another bug for it.

Edit LAYOUTNAME.pm

You must include the theme into the general style file. Otherwise, people wouldn't be able to select it at Customize.

• Find the correct place in the file so that themes stay alphabetically sorted.

• Add the following code:

package LJ::S2Theme::layoutname::themename;
use base qw( LJ::S2Theme::layoutname );
sub cats { qw() }

• If the color theme author is not the style author, add this line:

sub designer { "someuser" }

On PuTTY

• Type hg addremove if this patch adds or delete files then hg refresh.

On your Dreamhack

• Test, test and test. Make sure styles/themes are correctly listed in Customize and that names are correct. Make sure you can select the layouts working with your style. Make sure you can customize your style. On your test account, check colors on all pages for themes. For styles, make sure all types of layouts, all pages, all sorts of entries and comments display correctly and display correctly in various screen resolutions and font sizes. Also make sure community journals look fine.

• Make preview pictures if you can. Their size is 150x114 pixels. You may need to add/edit/remove entries, add/edit/remove modules, change screen resolution and font size so that your screen cap can be resized to this exact size.

On Bugzilla

• Don't forget to zip images and attach them to your bug if there are any. Also set them to review ? and commit ?

• If you can't do the preview pictures mention it so that someone can do them for you. You can also ask for help at dreamscapes.