1. Summary
  2. Files
  3. Support
  4. Report Spam
  5. Create account
  6. Log in

Author Guidelines

From notepad-plus

(Difference between revisions)
Jump to: navigation, search
(Visual codes)
(General rules)
Line 6: Line 6:
* We prefer NP++ as the shortened form of Notepad++.
* We prefer NP++ as the shortened form of Notepad++.
* Titles should be capitalised (that is, all major words should start with capitals)
* Titles should be capitalised (that is, all major words should start with capitals)
-
* Pagenames should be capitalised as well.
+
* Page names should be completely capitalised.
-
* Pagenames may contain spaces and the '+' character
+
* Page names may contain spaces and punctuation. As long as PHP can encode it, it is ok.
 +
* "View after saving" is as much encouraged as "Test after shipping". Both practices stand for poor quality and disrespect. Please avoid them. "Errare humanum est, perseverare diabolicum".
 +
* Before and after writing, ask yourself whether you'd like to see inaccurate, off topic, misworded or otherwise inadequate material. The standing assumption is that you don't. Just Show preview and read once more what you wrote before clicking Save page.
 +
* Bots, Vandals, Huns, propagandists and other wrongdoers are unwelcome. They will be blocked and/or banned swiftly whoever spots their mischief, reported to Sourceforge, and prosecuted if applicable.
=== New pages ===
=== New pages ===

Revision as of 11:10, 11 June 2009

NpWiki++ Author Guidelines


Contents

General rules

  • Use British English spelling and grammar except where computer terms require US spelling. For example, dialog box, localization, etc.
  • We prefer NP++ as the shortened form of Notepad++.
  • Titles should be capitalised (that is, all major words should start with capitals)
  • Page names should be completely capitalised.
  • Page names may contain spaces and punctuation. As long as PHP can encode it, it is ok.
  • "View after saving" is as much encouraged as "Test after shipping". Both practices stand for poor quality and disrespect. Please avoid them. "Errare humanum est, perseverare diabolicum".
  • Before and after writing, ask yourself whether you'd like to see inaccurate, off topic, misworded or otherwise inadequate material. The standing assumption is that you don't. Just Show preview and read once more what you wrote before clicking Save page.
  • Bots, Vandals, Huns, propagandists and other wrongdoers are unwelcome. They will be blocked and/or banned swiftly whoever spots their mischief, reported to Sourceforge, and prosecuted if applicable.

New pages

New pages should start with either

{{New Article}}

or

{{New Article| Longer and more descriptive header}}

The purpose of this is multiple:

  • Ensure some homogeneity in page appearance
  • Give a chance to reader to go to another page s s/he landed there by error
  • Link the page to a specific category used for management

Category links

They should appear at the bottom of the page, mirrorring their Wiki rendering. This is useful to review the indexing and easily change it.

Adding a topic/keyword category link is encouraged as soon as it is relevant, and it is to be expected that some people will expect to see the page listed when looking up the keyword.

Removing a keyword link, however, should be seen as correcting a mistake, or splitting an overloaded topic.

New topics

Adding a category link that didn't exist before is not enough. The category has to be created. You will tell this condition by a red link in the category footer. Simply follow the link. You will be led to editing the new category. Enter

{{kwcat}}

and save page. You are done. What the template does is to generate a presentation text and integrate the new topic into the indexing structure.

Visual codes

While boredom may have been born from uniformity, chaos certainly arises from randomness. Try to integrate into the general look and feel of the Wiki.

In order to make source files, menu commands and configuration dialog elements more obvious and standing out from text, specific templates have been designed tospare typing and present the casual reader with an easy to read color code. Authors are encouraged to use all tools in Author Toolbox, specially in the "UI quotes" section.

Editing some pages with advanced formatting mmay prove challenging for people with hardly any expertise in wiki markup. If you feel you are going to cause a mess, or already have, just ask the admins. We may have enough experience to solve the problem soon.

Personal tools
INVISIBLE