From 8972f6e01e9b8b0426d1094d7e092108c98d37bf Mon Sep 17 00:00:00 2001 From: "David E. Bernholdt" Date: Fri, 13 Oct 2023 11:33:05 -0400 Subject: [PATCH] Updates to style guide --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff80173..5a13d66 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ Plan: move into production at https://ideas-productivity.org/ in November 2023 * This site represents the entire IDEAS family of projects and spin-offs. All content should reflect this (e.g., connections are encouraged, writing as if the project or activity is completely separate from anything else is discouraged). * We prefer shorter "light-read" content to longer content and more formal language. The website is not a technical paper -- pasting content from a paper is probably not desirable. * Longer-form content is okay if this is the only place that it appears. Consider shorter content that links to outside resources. Longer-form content is more likely to appear further down the website hierarchy (for example on a sub-page of an activity rather than the activity's main page) + * Try to avoid significant content on a topic appearing in multiple places on the site. If there is a page with the "meat" of the topic, other mentions can be shorter and point to the meat * Cross-linking within the site is encouraged * External links are encouraged, but we have a strong preference for persistent identifiers (e.g., DOI links) and links that we expect to be durable * Language and styling @@ -30,10 +31,10 @@ Plan: move into production at https://ideas-productivity.org/ in November 2023 * Page titles and other `title` content should use title case * Other headings should use sentence case * We prefer to use H1 as the highest level headings for page content (not H2) - * `blurbs` (an optional element of most pages and include files) used more or less as subtitles should use sentence case and **end with a period**. - * Subtitle `blurbs` should be action-oriented where possible + * `blurbs` (an optional element of most pages and include files) used more or less as subtitles should use sentence case but should *not* end with periods + * Subtitle `blurbs` should active "-ing" words where possible * Use subtitle `blurbs` only where they make sense -- they're *optional* - * `blurbs` for `text-biglink.html` includes should be all lowercase, except for acronyms + * `blurbs` for `text-biglink.html` includes should be all lowercase, except for acronyms or key phrases * For project names that start with "IDEAS", use a hyphen to link to a distinguishing term. For example, IDEAS-Classic, IDEAS-ECP, or IDEAS-Watersheds rather than IDEAS Classic, IDEAS ECP, or IDEAS Watersheds * Graphics * Graphics with a transparent background are generally preferred wherever possible. This means PNG or GIF format. JPEG files do not support transparent backgrounds