Difference between revisions of "Contributing"
m (added "TI-83 and" to intro and pluarized system) |
|||
| Line 1: | Line 1: | ||
| − | Because the main goal of WikiTI is to organize and collect documentation for the TI-83 Plus Family's operating | + | Because the main goal of WikiTI is to organize and collect documentation for the TI-83 and TI-83 Plus Family's operating systems, we want to keep this Wiki as organized as possible. One of the contributing factors of the creation of this Wiki was to make sure that the documentation that had been spread among many message boards and posts could be brought to one central place; therefore we want to make sure this resource is as useful as possible. Because of this goal, we ask that all contributers follow the rules described below. |
== Contributing Guidelines == | == Contributing Guidelines == | ||
Revision as of 22:08, 13 May 2005
Because the main goal of WikiTI is to organize and collect documentation for the TI-83 and TI-83 Plus Family's operating systems, we want to keep this Wiki as organized as possible. One of the contributing factors of the creation of this Wiki was to make sure that the documentation that had been spread among many message boards and posts could be brought to one central place; therefore we want to make sure this resource is as useful as possible. Because of this goal, we ask that all contributers follow the rules described below.
Contributing Guidelines
One of the biggest problems in working with undocumented information is trying to come up with a naming system. The classic example is most of the TI-83+ hooks, which were horribly misnamed until their proper behavior was discovered. Therefore, it is our goal in WikiTI to store all information by internal addresses, instead of names, as the former can't be confused.
Before you continue, make sure you are familiar with the basics of editing and posting in Wikis, as this won't make much sense if you don't. If you don't know how to post, read our help!
The naming system for all documentation is seperated into parts: the calculator family, the category, and the address (in hexadecimal). Each is seperated by a colon.
As an example, let's assume that I want to post some new documentation about a B_CALL that I discovered. The address of the entrypoint is 0042 (which is in hexadecimal), and I've decided to call the entrypoint "ProveTheRiemannHypothesis," which seemed to be the name most fitting to entrypoint.
By our naming convention, the name for this article would be 83Plus:BCALLs:0042. Note that I use the hexadecimal address, not the name I've decided to give it. To go to this page, enter the name in the "goto page" box on the left hand side of the page. If the page exists, you will be taken to it. If the page doesn't exist, you can click edit to create the page with that name. Do so, and provide the documentation following the templates below. Make sure you include appropriate [[Category:blarp]] lines or no one will be able to find your documentation.
Templates
To start your documentation, click one of the appropriate template pages below, and click the "view source" tab on that page to view the source generating the template. Make sure to replace all the filler content with actual content (since the examples are nonsensical anyways.) This includes the bit at the top before the first == Header ==!
