Difference between revisions of "Contributing"
m (added "(in hexadecimal)" to the naming format) |
|||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | The main goal of WikiTI is to organize and collect documentation for the TI-83, TI-83 Plus, TI-83 Plus SE, TI-84 Plus/SE, and TI-84 Plus C SE calculators. (We're not against documenting other models, but you'll probably be doing it alone.) Unlike Wikipedia, WikiTI ''is'' a place where you can put your original research. Major community projects may also be documented here. | |
| + | |||
| + | We want to keep this Wiki as organized as possible. Previously, information was spread among many different boards and Websites. We want the Wiki to be a central place for all relevant information. In order to keep the Wiki organized and useful, we ask that all contributors follow the rules described below. | ||
== Contributing Guidelines == | == Contributing Guidelines == | ||
| Line 7: | Line 9: | ||
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:Contents|help]]! | 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:Contents|help]]! | ||
| − | The naming system for all documentation is | + | The naming system for all documentation is separated into parts: the calculator family, the category, and the address (in hexadecimal). Each is separated 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 entry point is 0042 (which is in hexadecimal), and I've decided to call the entry point "ProveTheRiemannHypothesis," which seemed to be the name most fitting to entry point. | |
| − | ''' | + | 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 <nowiki>[[Category:blarp]]</nowiki> lines or no one will be able to find your documentation.'' |
| − | + | If, for some odd reason, you can't figure out how to properly format the data with wiki formatting, just post your information in some coherent form. Just make sure you put '''''<nowiki>{{Wikify}}</nowiki>''''' at the top so we can see that it needs work. A full listing of pages needing Wikified is at [[:Category:Wikify]]. | |
== Templates == | == 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.) | + | 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 <nowiki>== Header ==</nowiki>!''''' |
| − | * [[ | + | * [[BCALLs Template|B_CALL/ROMCall Template]] |
| − | * [[ | + | * [[Flags Template|Flag Template]] |
| − | * [[ | + | * [[Hooks Template|Hook Template]] |
| − | * [[ | + | * [[Ports Template|Port Template]] |
| − | * [[ | + | * [[RAM Template|RAM Area Template]] |
Latest revision as of 11:54, 12 March 2013
The main goal of WikiTI is to organize and collect documentation for the TI-83, TI-83 Plus, TI-83 Plus SE, TI-84 Plus/SE, and TI-84 Plus C SE calculators. (We're not against documenting other models, but you'll probably be doing it alone.) Unlike Wikipedia, WikiTI is a place where you can put your original research. Major community projects may also be documented here.
We want to keep this Wiki as organized as possible. Previously, information was spread among many different boards and Websites. We want the Wiki to be a central place for all relevant information. In order to keep the Wiki organized and useful, we ask that all contributors 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 separated into parts: the calculator family, the category, and the address (in hexadecimal). Each is separated 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 entry point is 0042 (which is in hexadecimal), and I've decided to call the entry point "ProveTheRiemannHypothesis," which seemed to be the name most fitting to entry point.
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.
If, for some odd reason, you can't figure out how to properly format the data with wiki formatting, just post your information in some coherent form. Just make sure you put {{Wikify}} at the top so we can see that it needs work. A full listing of pages needing Wikified is at Category:Wikify.
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 ==!
