Difference between revisions of "Contributing"
| Line 5: | Line 5: | ||
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. | 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:Contents|help]]! | |
| − | + | The naming system for all documentation is seperated into parts: the calculator, the category, and the address. 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. The first thing I would do is see if any information already exists about my B_CALL by searching for that page name in the search box on the left side. If there was any information, the previous poster wouuld have (hopefully) followed the same naming guidelines, and you could easily contribute to the page. | |
| − | + | Let's assume that the page wasn't found, and you want to start it. First, click the calculator documentation link on the sidebar, and click the category that fits it. Then click edit on that page. In this page, you will have a list of all the entrypoints that have been documented. We would add our entrypoint as such: | |
| − | <nowiki> | + | <nowiki>* [[83Plus:BCALLs:0042|0042]] - ProveTheRiemannHypothesis</nowiki> |
| − | + | '''Note:''' Make sure you keep the list in a logical order! In this case, B_CALLs should be sorted by address. | |
| + | |||
| + | After you have saved that list, then click your new link, edit that page, and provide the documentation there. | ||
| + | |||
| + | To start your documentation, click one of the appropriate template pages below, and click edit 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.) | ||
| + | |||
| + | * [[Template:BCALLs|B_CALL Template]] | ||
Revision as of 07:32, 25 March 2005
Because the main goal of WikiTI is to organize and collect documentation for the TI-83 Plus Family's operating system, 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, the category, and the address. 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. The first thing I would do is see if any information already exists about my B_CALL by searching for that page name in the search box on the left side. If there was any information, the previous poster wouuld have (hopefully) followed the same naming guidelines, and you could easily contribute to the page.
Let's assume that the page wasn't found, and you want to start it. First, click the calculator documentation link on the sidebar, and click the category that fits it. Then click edit on that page. In this page, you will have a list of all the entrypoints that have been documented. We would add our entrypoint as such:
* [[83Plus:BCALLs:0042|0042]] - ProveTheRiemannHypothesis
Note: Make sure you keep the list in a logical order! In this case, B_CALLs should be sorted by address.
After you have saved that list, then click your new link, edit that page, and provide the documentation there.
To start your documentation, click one of the appropriate template pages below, and click edit 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.)
