User:Retor/Notes on editing

Jump to: navigation, search
My own notes, nothing official

In short

  • Templates are either complete article templates or snippets of reusable code (such as Navbar, Knowledge)
  • Namespaces seperated different types of content
  • Categories groups common pages. Categories tagged with categories creates nesting, as [[Category:Wiki_styling_help]], seen on portal:wiki.
  • Portals are front pages for a topic, such as portal:wiki. Keep design.

Useful wikitags

  • Format code: use htmltags code and nowiki
  • Redirect: #REDIRECT [[Portal:Wiki]]
  • Mark for deletion: {{delete|reason}}
  • Mark for deletion if redirect: [[Category:Redirects to delete]]
  • Mark for expasion {{expand}}
  • Mark as obsolete {{Obsolete|Version}}
  • Create an intro: {{Intro|{{Lorem ipsum}} }}
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
  • Info field: {{Info|Please refer to [[Help:Editing]] in order to write a quality approved article.}}
Please refer to Help:Editing in order to write a quality approved article.
  • Mailing list {{Mailinglist|opensuse-list|Short description of the mailing list}}
  • opensuse-list@lists.opensuse.org - Short description of the mailing list.
    Subscribe - Unsubscribe - Help - Archives
  • Create a table of content __TOC__



Style in brief

Based on Help:Style.


Titles

  • Clear and short
  • No : in titles or headings, only a_z, 0-9, nor /
  • Spaces, not cammelcase - and Capitalization like normal text
  • No links or special formating in headings
  • Don't name first article about or introduction
  • Lowest level heading is ==
  • Use ---- before == (well - no)


Articles

  • Keep it short and conscice - dont' reapeat stuff (see if it already exists)
  • No trademark characters
  • Use the full name of accronyms on its first occurrence followed by the abbreviated form in paranthesis
  • Photos in jpg, animations in gif and drawings etc in png

Also: Help:Editing


Layout

  • No overview pages (if so Portal)
  • Info before intro
  • no TOC or ---- on short pages

Commands

Help:Style#Elements

Switch username with <username>, and sda with sdX (capital -> error), and tell what to put instead of <username> or sdX. 

<code>key press </code>
<tt>/path/to/directory/or/file</tt>
{{Shell|$  command}}
 (blank space)short output text
Retrieved from "https://en.opensuse.org/index.php?title=User:Retor/Notes_on_editing&oldid=71548"