Universal Devices, Inc. Wiki:Community Portal

From Universal Devices, Inc. Wiki
Jump to: navigation, search

Join The UDI Wiki Team

This collaborative Wiki is intended to be continually developed by Universal Devices Inc. and its user base. In order for this guide to improve it needs user support. The best way to help is by contributing your own information, experiences, tips, and examples. So if you’re interested in developing this guide, please request a login ID by dropping us a note on our Tech Support email address.


If you're joining the UDI Wiki editing team please see our Help section which can also always be found in the navigation box on the left of every Wiki page. Also if your wondering who is working on this Wiki you can check our User List.

Working On Wiki Documents

If you start a inital write-up try to complete it enough that the whole idea is expressed. Then after that other users can fine tune the work. For editing discussions use the Wiki discussion tab for each page. Also provide a link at the bottom of the page that points to the forum thread that pertains to the topic, see the Page Conventions section below for more details.


Uploading Files

Avoid Lossy Screen Captures - When uploading screen captures from the computer please use one of the lossless GIF or PNG file formats because the hard edges of screen captures don’t look good when using a lossy format like JPEG.

Don't use remote hosted pictures in the Wiki - There is no reason to because all you need to do is use the Upload File to add the GIF or PNG files to the Wiki. If your looking for an already uploaded file you will find it listed on the File List page or another nice way is the File Gallery page.

Lossy JPG - 9kb
Lossless GIF - 8kb

Page Conventions - Hierarchal Navigation Links

Here are a couple of examples for the bottom page linking that most pages use. This gives the reader some Hierarchical navigation to move around the section they are reading. The bottom navigation links also should be under the ---- line for visual separation from the rest of the page.

----
[[ISY-26 INSTEON|ISY-26 INSTEON]] '''/'''
[[ISY-99i Series INSTEON|ISY-99i Series INSTEON]] ''':'''
[[ISY-99i/ISY-26 INSTEON:User Guide|User Guide]]

Example: ISY-26 INSTEON / ISY-99i Series INSTEON : User Guide

----
[[ISY-99i Series INSTEON|ISY-99i Series INSTEON]] ''':'''
[[ISY-99i/ISY-26 INSTEON:How-To Guide|How-To Guide]]

Example: ISY-99i Series INSTEON : How-To Guide

Page Conventions - Main Forum Thread Link

Also another good suggestion is to point to the main thread for the topic in the forum, on the bottom of this page it has its own forum link example.

[http://forum.universal-devices.com/viewtopic.php?p=5131 Improved Documentation (Forum)]

Example: Improved Documentation (Forum)




Improved Documentation (Forum)