GNOME Website Editing Guidelines

General Editing

  • Filling in the Description field (required on all pages) creates an <h2> on the page. Try to make this match the corresponding link text in the navigation.

  • TODO: Guidelines about document workflow states

Common mistakes to avoid

  • Refer to "latest release" and similar expressions instead of "GNOME 2.18" or similar, unless you really want to refer to a specific version of GNOME. This way we avoid having to update pages (and their translations) when a new release comes.

HTML Markup

  • The body of a page should only use <h3> to <h6>, since <h1gt; and <h2> are already used for the GNOME header and the document title.

  • Don't blindly trust the WYSIWYG editor! Please check the HTML for inconsistencies/bad HTML when editing a page (click the "HTML" icon on the editor toolbar). If possible, edit in HTML mode only. Ideally, make sure that pages validate after editing.
  • Avoid the editor's bold, italic, or text alignment buttons. This method creates purely presentational markup, such as the <b> and <i> tags and the deprecated align attribute. Use HTML mode and <strong>/<emph> tags or CSS instead.

  • Specify meaningful alternate text for all images. Do not use the <img> tag for presentational (or non-content) images, use CSS and background-image instead.

  • Aim for consistency. Try to avoid making a page differ too much visually.

Plone Theming

  • Make an entry in the ChangeLog for every file/change that you make.

  • Try to test in as many browsers as possible before committing significant changes. If necessary, it may be helpful to download a single static page to play around with.
  • The edit site is set to debug-mode, so most change should show up there immediately. Certain changes will require zope to be restarted.

GnomeWeb/EditingGuidelines (last edited 2008-02-03 14:44:30 by localhost)