DokuWiki

It's better when it's simple

User Tools

Site Tools


tips:good_style

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
tips:good_style [2014-05-30 08:01] 121.99.36.5tips:good_style [2021-12-28 03:33] (current) – [Hints on good style] andi
Line 2: Line 2:
  
  
-These are a few hints on how to write a good wiki page.+These are a few hints on how to write a good wiki page. See also our [[tips:good_content|hints on good content]].
  
 ===== Page structures ===== ===== Page structures =====
Line 14: Line 14:
   * If most of the pages of a [[:namespace]] share a common structure add a [[:namespace template]] so any new page can begin with that skeleton structure.   * If most of the pages of a [[:namespace]] share a common structure add a [[:namespace template]] so any new page can begin with that skeleton structure.
   * Try to avoid overcomplicated namespace structures. Try to use short, easy to remember namespace names.   * Try to avoid overcomplicated namespace structures. Try to use short, easy to remember namespace names.
 +  * Consider utilizing the [[plugin:qc|Quality Check Plugin]] as a wiki owner or contributor to assist in page structure and text formatting.  
  
 ===== Text formatting ===== ===== Text formatting =====
Line 44: Line 45:
 ===== Images and other media ===== ===== Images and other media =====
  
-  * "An image says more than a thousand words." It might even mean //more than you intended// to say. Humans tend to question the authenticity of images less than that of language. A short textual description is better than an inaccurate picture.+  * "An image says more than a thousand words." It might even mean //more than you intended// to say.((Also, you can not express this quote as a picture, can you?)) Humans tend to question the authenticity of images less than that of language. A short textual description is better than an inaccurate picture.
   * As with tables, always provide a caption for images, that states what you want to show with the image.   * As with tables, always provide a caption for images, that states what you want to show with the image.
   * If you did not create the picture yourself, state the source (possibly with a link) and the copyright.   * If you did not create the picture yourself, state the source (possibly with a link) and the copyright.
   * Don't link images from external sites, unless when allowed to do so explicitly. This is firstly a matter of copyright but can also be a matter of bandwidth stealing when [[config:fetchsize|caching for external images]] is disabled.   * Don't link images from external sites, unless when allowed to do so explicitly. This is firstly a matter of copyright but can also be a matter of bandwidth stealing when [[config:fetchsize|caching for external images]] is disabled.
-  * If the picture is bigger than roughly a third of a screen page, use a [[:wiki:syntax#images_and_other_files|link with resizing instructions]] to insert a thumbnail.+  * If the picture is bigger than roughly a third of a screen page, use a [[:wiki:syntax#media_files|link with resizing instructions]] to insert a thumbnail.
tips/good_style.1401429667.txt.gz · Last modified: 2014-05-30 08:01 by 121.99.36.5

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki