|Version 1 (modified by rado, 22 months ago) (diff)|
Help seekers to help themselves, so they can find their way alone and maybe develop a desire to learn more about what else could be done to enhance their mutt experience beyond their expectations or considerations.
There are (at least) 2 strategies:
- "do not spoonfeed people, let them (learn to) eat on their own ('do it yourself')."
- "don't waste my time, just tell me the solution."
The latter is very seductive, for both sides, the requester aswell as the responder. However, since _somebody_ has to spend the time to analyze a problem and provide a solution, this means beyond the effort to provide the solution, the burden to explore the case lies on the responder, too. That's bad balance.
Not only that: effort has already been spent on the bundled documentation. Merely duplicating it via other resources is wasted energy. Instead value can be added by using different approaches and perspectives, to better explain the given docs. So please, try not just to copy stuff; if you have nothing to add, the just reference the source for a given solution.
With power comes responsibility.
As much as we appreciate any effort, please save everybody (including particularly yourself) from having to spend time on correcting formal errors by following these guidelines before you edit. The time saved you can use to add more new content. :-)
Learn the simple WikiFormatting syntax of the engine powering this MuttWiki.
It's line- oriented and the 1st column of a line determines the type of output- line.
Use SandBox as playground to get used to editing this Wiki before you mess around with the real stuff. ;-)
Anyway, please consider these organisational guidelines:
- add a brief summary of the change you made for the RecentChanges log.
- use short but intuitive link names (enough clue to the content, but not complete titles/ questions).
- CamelCase preferred, don't hide URLs unless required for readability, in particular don't use "_" (underscores or spaces).
- do not use "I" or "my", keep text as generic as possible.
- make use of the "/subpage" linking or use a categorizing prefix for related pages to keep some structure of docs.
- use the preview button to verify before you save!
- keep an eye on RecentChanges in case some impatient newbie acts before becoming a WikiWorker, or worse a spammer malevolently hijacks our site!
Technical tips for editor applications (browser built-in or external):
- some pages can become too big for your editor to load fully, so don't save crippled pages.
- some editors have weird formatting behaviour (wrapping, indention).
- when using txt-browsers, you should use your choice external editor!
- however, when doing so, do not let the browser wrap the lines for you when you return from the editor!
The essence of this: use the preview before you save!
Lynx-users should keep http://c2.com/cgi/wiki?UsingWikiWithLynx in mind, too.
About raw wiki text:
The first column of a wiki-raw line is the key for type of output. WikiFormatting by 1st column work only on single lines, therefore do not wrap such lines without breaking them properly!
Rather than wrapping lines with "\" as with other wikis, simply continue a given line on the following, by indenting it with at least 1 space. Additional follow-up lines should carry the same indention to stay grouped.
Don't do this for "normal" text, since paragraphs are automatically "joined/ continued".
If you don't wrap properly, the indention will break the wiki-display. Therefore remember to use the preview before you save!