Style sheet

From Cynefin.io
Jump to navigation Jump to search

This article covers basic style guide conventions for editing articles. Please take the time to have a quick look at these if you've not used a wiki before or don't understand what Markup is.

Conventions

These are the main conventions used on cynefin.io:

  • In general we follow conventions laid out on the English Wikipedia. Note we are using English spelling in preference to American
  • All article titles should only use an upper case letter for the first work and all other letters/words should be lower case
  • Cynefin should always be written Cynefin® as should SenseMaker®
  • Use the 'minor edit' tag for things that you know everyone else would consider minor, such as typos or changes that don't change the meaning or context. This will help people when reviewing.
  • Always provide a summary of any edit that changes the meaning. Use the format of what you did, and why you did it as this provides a decision log for reviewers.
  • Never ever cut and paste the same text into different articles. Instead, create a new page that can be linked and make sure the name is in the directory. You can simply do this by add [[New page]] to the current page and then clicking on it after saving
  • Please use Markup over HTML, that is don't sprinkle excessive <br> through the article as it detracts from readability, just press return and just add a blank line. Also please restrict your use of <div> to headers where there is justification as it makes the maintenance of the text difficult.
  • Note: you can add comments to the text itself and this may be helpful if you are developing a section and have some points that need elaboration. The format is <!-- comment -->

Some basic markup language

You can find many wikitext examples here.

This is Markup for italic text, while this is bold and should be used these in preference to HTML <i></i> and <b></b>, but <s></s> are necessary for strike-through.

The following are examples of headers and you just use '=' per level for a second level leading it is '==' and so on. Please try to not go beyond three levels

This is a first-level subheading

This is a second-level heading.

For numbering, you use a '#'. For example:

  1. First
  2. Second
    1. Second level
    2. Another item

And for bullets use *. For example

  • First
  • Second
    • Second level indent
      • Third level indent

And you can use four '-' to draw a line across the page.


Linking

  • If you reference an article on the wiki always link to it as follows: [[Article name]].
  • If you want to reference an article but you need to change the description then you can just add then after the article name as here [[Article name|name you want to use]]
  • Similarly if you are linking to a website then [websitename your description] should be used. Note there is no need for a '|' here as it is implicit.

Talk page conventions

  • ALWAYS sign your comments on talk pages and see the link for guidance on creating your own personal signature.

To sign a comment you use the 'signiture' icon in the edit bar or use four '~' (it is Alt-N on a Mac Keyboard).

  • When commenting remember to indent your text with colons.

Colons work like this:

Original comment. Your signature.

First response. Your signature.
Response to the response. Your signature.
Response to the response to the response. Your signature.
Second response to the original comment. Your signature.
  • To mention other users

If you want to mention other users then use {{Reply to|username}} template. e.g. @Jay0:. Note templates are always enclosed in {{ }}

  • Using headlines to identify topics can be helpful for high use talk pages.

A talk page template for a busy page might look something like this:

Talk page subject for discussion as a headline

Specific sub topic as a sub headline

Your question, comment, contribution. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)

First response. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)
Response to the response. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)
Response to the response to the response. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)
Second response to the original comment. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)

New sub topic for discussion

Your question, comment, contribution. Your signature here: ---  kitt (TALK)  08:14, 24 February 2021 (UTC)