Help:Editing

From Helpful
Jump to: navigation, search

See also Helpful:About, and the Main Page.






Conventions

Not many.

Mainly 'Minimize visual clutter'


Sections are good, particularly where they aid someone to the right bit of content. A simple summary, 'usually this amounts to', and 'crazy details' can coexist this way.

Or just if you have a page full of text.


Linking to software's project page, (interesting parts of) manuals, datasheets, and such (whatever you're augmenting or drawing together) is nice. The wikipedia page may be a lazy way as it usually links to those things well enough.


When adding web links, try to mention the title of the linked content to make them recognizable as well as easier to fix when they 404.


I have the habit of keeping half-arsed content in <-- --> style comments, when I want to do some more polishing before it becomes visible. You may want to look for that if you suspect there's some reason for that empty section.

Wiki syntax, templates, and such

See Markup_language_notes#mediawiki for some syntax notes.

Basic templates in here

There are some defined templates you can use if you wish, currently including:

In-text:

  • {{verify}} puts a bracketed 'verify me'. Useful when you're not entirely sure of what you or someone else states. Looks like (verify). Partially made so that people who want to polish stuff can look for uses of this template.
  • {{comment}} make parenthetical text subtler in-page, and consistently style in the wiki, and easy to change in style later. {{comment|this syntax}} currently gives this effect. Useful for things, such as (This is not guaranteed to be thread-safe on all systems.).
  • {{inlinecode}} can be used in paragraph text to get a style that imitates text blocks (constant-width font, background color). {{inlinecode|this syntax}} currently gives
    this effect


Page/section markers (see next section)

  • {{stub}} - nice whenever you dump in a few links and sentences in preparation, so for pages that haven't received real attention from writers/editors. In some cases it can make way for one of the other templates, in other cases it can fall away once the text is decent. look for uses of this template
  • {{feelfree}} means something isn't finished, and can also signal "I'm not sure of much more than this". look for uses of this template


Other templates

  • {{search|query}} - a web search (currently google) for the first argument. Link text is the same string, or the second argument if there is one.
  • {{imagesearch|query}} - an image-search variant of the last
  • {{luckysearch|query}} - first hit for a web search for the first argument (google's feeling lucky)
  • {{key|string}} - meant as a visual representation of a keyboard key, to e.g. do Ctrl+c
  • various subject-related TOC-like things to navigate to related pages

Code

For monospaced and a visual eye-draw, you can use {{inlinecode|this --effect}}, for
this --effect
.

Try to use this sparingly, only for real examples. If you just want monospacing, add <tt> tags (also less bother about wiki exceptions).

Note that the almost-verbatim one-space-indented wiki blocks can be made verbatim, no-extra-indentation-necessary by putting a <nowiki> around the contents, like (click edit to see the markup):

def yay():
  for i in range(10):
    print "thing %d"%i

As long as GeSHi is installed, you can also get syntax higlighting for various things. Wrap the code in <code lang="python">, </code>, or whatever the language is:

def yay():
  for i in range(10):
    print "thing %d"%i