ZTWiki conventions

Page name

While there are no technical restrictions on page name, please follow the following guidelines:

• Try to be short and explicit.
• When editing, assign a category to the page. Most of the time, one category is sufficient, but you can assign more than one category if required.
• Avoid mentionning the obvious, such as specifiying a feature is "for ZTreeWin" when this whole wiki is dedicated to this software or writing "Script for suchandsuch purpose" when the assigned category is script.
• Note that users with Editors privileges may rename your page or recategorize it for organizational or clarity purpose.

Page editing

• If you start a page with a title line, avoid rewritting the title page. A title is specified by starting the line with an exclamation mark (!).
• Use the Description field whenever possible.
• Fill the Edit Summary whenever possible. This summary is shown when viewing the History subpage. It summarizes what changes you made on the page.
• If you make slight modifications to a page, such as fixing formatting or correcting spelling mistakes, check the ''Minor' checkbox. This avoid archiving a useless former version of the page.

Images

• You can display any number of images in a page. When you use the Upload picture feature on the Edit page, images are uploaded to a public folder named img\wiki_up. Because all public images coexist in that folder and because the administrator of ZTreeWiki may eventually move the images to a more appropriate folder, try to use names identical to page name. Example: If your page is SomeDemo, your images should be: SomeDemo01.png, SomeDemo02.png, etc.
• For screenshots, use PNG format (preferred) or GIF format. For regular pictures, use JPG.
• To reduce bandwidth and server space, try to capture only the significant part of the screen, application or menu you want to show.
• The recommended tool for screen capture and anotations is the excellent freeware FastStone Capture.
• When taking ZTreeWin screenshots, anticipate a capture size suitable for most browsers. The smaller, the better.
• Whenever possible, avoid using an image located outside ZTreeWiki. It's both impolite and unwise. Rather, make a copy of the external image, upload it to ZTreeWiki and use the local copy.

Sources

• Try to keep track of sources and external contributors. ZTreeWiki can only credit as contributors users who actually edited the page. It's your responsibility to give the real credits, usually at the end of the page.
• If your post is a derivative of from a prior post on ZTreeForum, it's considered good practice to hyperlink the original thread.

---