Difference between revisions of "Contributing"
(changed person from second to first in a few places and updated the name redirect code) |
|||
| 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. | ||
| − | For example, consider I wanted to post information about the 83+ B_CALL 4CA8h, which I have decided to call "StartSmallEdit." I would post all my documentation about this B_CALL in the page named 83Plus:BCALLs:4CA8, so anybody else with information about this B_CALL can easily find | + | For example, consider I wanted to post information about the 83+ B_CALL 4CA8h, which I have decided to call "StartSmallEdit." I would post all my documentation about this B_CALL in the page named 83Plus:BCALLs:4CA8, so anybody else with information about this B_CALL can easily find my documentation (without worrying about what I called it.) If I want to assign a name for it, I would then create a second page 83Plus:BCALLs:StartSmallEdit, which should redirect to 83Plus:BCALLs:4CA8. The same pattern should be used for other types of documentation. Obviously, the 83Plus:BCALLs:4CA8 page can contain (in the page text) the name for the entrypoint. |
We must also attach these articles to the appropriate categories. At the start of 83Plus:BCALLs:4CA8, you should put the following line: | We must also attach these articles to the appropriate categories. At the start of 83Plus:BCALLs:4CA8, you should put the following line: | ||
| Line 13: | Line 13: | ||
Note the pipe in that command--this tells WikiTI how it should sort the article in the category list. | Note the pipe in that command--this tells WikiTI how it should sort the article in the category list. | ||
| − | Then, in the 83Plus:BCALLs:StartSmallEdit article (which redirects to the real article), add the following | + | Then, in the 83Plus:BCALLs:StartSmallEdit article (which redirects to the real article), add the following lines: |
| − | <nowiki>[[Category:83Plus:BCALLs|StartSmallEdit]]</nowiki> | + | <nowiki>#REDIRECT [[83Plus:BCALLs:4CA8]] |
| + | [[Category:83Plus:BCALLs|StartSmallEdit]]</nowiki> | ||
This allows the proper names to be listed in the category list. | This allows the proper names to be listed in the category list. | ||
Revision as of 17:32, 24 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.
For example, consider I wanted to post information about the 83+ B_CALL 4CA8h, which I have decided to call "StartSmallEdit." I would post all my documentation about this B_CALL in the page named 83Plus:BCALLs:4CA8, so anybody else with information about this B_CALL can easily find my documentation (without worrying about what I called it.) If I want to assign a name for it, I would then create a second page 83Plus:BCALLs:StartSmallEdit, which should redirect to 83Plus:BCALLs:4CA8. The same pattern should be used for other types of documentation. Obviously, the 83Plus:BCALLs:4CA8 page can contain (in the page text) the name for the entrypoint.
We must also attach these articles to the appropriate categories. At the start of 83Plus:BCALLs:4CA8, you should put the following line:
[[Category:83Plus:BCALLs|4CA8]]
Note the pipe in that command--this tells WikiTI how it should sort the article in the category list.
Then, in the 83Plus:BCALLs:StartSmallEdit article (which redirects to the real article), add the following lines:
#REDIRECT [[83Plus:BCALLs:4CA8]] [[Category:83Plus:BCALLs|StartSmallEdit]]
This allows the proper names to be listed in the category list.
