Croquembouche

CSS Policy

Use

Just like anything else on the wiki, a CSS theme must be licensed under the same Creative Commons site license, if it is hosted on the wiki. This means that anyone is free to use, copy, and alter that copy.

What they may not do is alter it for you. It would be treated like any other article or work on the wiki (minus being subject to deletion at this time. A deletion policy is not currently defined for CSS themes.)

What you can do:

  • Change any of the style components of the wiki which do not violate the can't section.

What you cannot do:

  • Remove, hide, alter, or "break" any navigation elements of the wiki.
  • Break the 'structure' of the wiki. Don't move the top-bar to 50% to the right, don't change the sidebar to be in wingdings unless that's your specific format screw going on.
  • Use the '!important' tag beyond what is required to override issues with the main CSS theme, or provide compatibility with your sub-themes or other CSS projects. Basically, don't make your theme be the only applicable theme.
  • Remove the rating module
  • Remove back/forward links from articles where they've been inserted.
  • Encourage users to import your theme using CSS @import rules.

What you must do:

  • Provide usage instructions.1
  • Encourage users to import your theme using Wikidot's [[include]] method (and set up your theme page accordingly - example here).

Translation Module

The translation module can only be modified with CSS to a very limited extent. In the event that the translation module clashes significantly, you are free to remove it via css, and maintain a list of translations in the comments section, or relevant hub for that article. Please try and keep it current to within a month at any given time.

Accessibility

This can be evaluated on a per-theme basis.

This section is difficult to explain, but the following should be considered when composing a theme:

  • Is this theme readable for colorblind people? (e.g. it employs bad color combinations like red + green which make it difficult for colorblind users to navigate the site)
  • Does this theme hamper the ability to use screen readers? (e.g. it adds 'invisible' content which gets read by screen readers but not sighted users)
  • Are the fonts it uses legible for all users? (e.g. the body font size is too small, the font itself is difficult to read)

and so on. Best practices and recommendations to address all of these potential issues are easily available with a cursory Google search.

Hotlinking

Hotlinking is the practice of linking to files on another site, and is both incredibly bad practice and against site rules. It is incredibly bad manners to force someone's site to load images for your theme, and also introduces a degree of unreliability to your theme — what if that site disappears?

To prevent hotlinking, all images, fonts and miscellaneous files used in a CSS theme must be files uploaded to the theme's page rather than linked from elsewhere on the internet.

However, you are permitted to use certain sites that explicitly encourage hotlinking for serving files to users. Notable examples include Google Fonts and Lorem Picsum. If in doubt, play it safe and ask the Tech Team.

Additionally, CSS should not be linked from sandbox pages or anywhere that isn't the main site (outside of workbenches). Please use a component: page on the wiki for CSS themes.

Remediating non-compliant themes

If your theme doesn't function in the major browsers (Internet Explorer 11, Firefox, Chrome, Opera, Safari) in a way that completely breaks navigation, function, or accessibility, it needs to be removed (or at bare minimum, removed from include blocks) from the site, then fixed, in that order.

Our first priority is compatibility, function, and accessibility.

cqb