Legacy:UnrealWiki To Do: Difference between revisions
From Unreal Wiki, The Unreal Engine Documentation Site
No edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{innerbox| The wiki is both your resource and your responsibility. Even if you have limited experience or available time, you can help. | |||
}} | |||
{{innerbox| Do one thing to help the wiki every day! | |||
}} | |||
A wiki doesn't run itself. It's a bit like a garden: things grow, and you need to keep it tidy with a bit of trimming and weeding. Wikis rely heavily on [[Wiki:WikiGnome]]s to stay healthy. | A wiki doesn't run itself. It's a bit like a garden: things grow, and you need to keep it tidy with a bit of trimming and weeding. Wikis rely heavily on [[Wiki:WikiGnome]]s to stay healthy. | ||
This page lists things '''you''' can do to help. If you have a spare moment, there's always little things | This page lists things '''you''' can do to help. If you have a spare moment, there's always little things each of us can do that add up to make a big difference in the usability of this place. | ||
==Things | ==Things To Do== | ||
===Quick stuff=== | ===Quick stuff=== | ||
Got a couple of minutes? Click on [http://wiki.beyondunreal.com/wiki?action=random Random Page] and... | Got a couple of minutes? Click on [http://wiki.beyondunreal.com/wiki?action=random Random Page] and... | ||
* Clean up any misspelled page titles: Put <nowiki>[[Legacy:Hello World|Hello World]]</nowiki>, not <nowiki>[[Legacy:Hello_World|Hello_World]]</nowiki>. | |||
* Wikify new pages: Create inline links, add a "Related Topics" section, move any comments to a "Discussion" section. | |||
* Tag long thread mode discussions with [[:Category:Legacy Refactor Me]] and a brief note on what specific info needs to be merged with the page text. | |||
* Tag pages that need obvious work with [[:Category:Legacy To Do]], include a brief description of the work needed as a note next to the tag. | |||
* Tag pages with Category Tags from the list found in [[:Category:Legacy Category]]. Tag class pages with [[:Category:Legacy Class (UT)]], [[:Category:Legacy Class (UT2003)]] or [[:Category:Legacy Class (UT2004)]]. | |||
* Browse through [[:Category:Legacy Category]] pages and identify those pages in every category that don't belong there; then either remove the wrong category links on those pages or "screen" them by adding an extra vertical bar at the end of the link, like <code>[[:Category:Legacy Category]]</code>. | |||
* Clean up class pages: ''(As an example, see [[Legacy:MinigunAttachment|MinigunAttachment]]. It was originally posted with only the Source Code.)'' | * Clean up class pages: ''(As an example, see [[Legacy:MinigunAttachment|MinigunAttachment]]. It was originally posted with only the Source Code.)'' | ||
** Add class hierarchy bar at the top. (Example, '''<nowiki>{{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Pawn|Pawn]]}}</nowiki>''': see [[Legacy:Guidelines On Technical Names|Guidelines On Technical Names]] for more.) Include package name in parentheses. | ** Add class hierarchy bar at the top. (Example, '''<nowiki>{{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Pawn|Pawn]]}}</nowiki>''': see [[Legacy:Guidelines On Technical Names|Guidelines On Technical Names]] for more.) Include package name in parentheses. | ||
| Line 13: | Line 27: | ||
** Add important or unique functions and events, try to include brief descriptions and the argument variables with variable types. | ** Add important or unique functions and events, try to include brief descriptions and the argument variables with variable types. | ||
** Add states, try to include brief descriptions. | ** Add states, try to include brief descriptions. | ||
* | ** Tidy up and update subclass trees, then tag with [[:Category:Legacy Class Tree]]. ''(See [[Legacy:NavigationPoint|NavigationPoint]] as an example)'' | ||
===Bit | ===A Bit Longer=== | ||
About half an hour... | About half an hour... | ||
* Create a page that people have made links to, but which doesn't yet exist. [[:Category:Legacy Wanted Pages]] gives a list of these. Or browse through [[:Category:Legacy Class Tree]] pages and fill in important class pages that don't exist yet. | |||
* Find [[Legacy:WikiTag|WikiTag]]s and deal with them: | * Find [[Legacy:WikiTag|WikiTag]]s and deal with them: | ||
** [[:Category:Legacy Refactor Me]] tags: Clean up bits of discussion ([[MeatBall:ThreadMode]]) and refactor it into [[Wiki:DocumentMode]] | ** [[:Category:Legacy Refactor Me]] tags: Clean up bits of discussion ([[MeatBall:ThreadMode]]) and refactor it into [[Wiki:DocumentMode]] | ||
** [[:Category:Legacy Link Me]] tags: Find the page the writer was thinking of and link it | ** [[:Category:Legacy Link Me]] tags: Find the page the writer was thinking of and link it | ||
** [[:Category:Legacy Answer Needed]] tags: Try to answer the question the writer couldn't answer himself and integrate it into the page instead of starting to write in [[MeatBall:ThreadMode]]. | ** [[:Category:Legacy Answer Needed]] tags: Try to answer the question the writer couldn't answer himself and integrate it into the page instead of starting to write in [[MeatBall:ThreadMode]]. | ||
===Big | ===Big Jobs=== | ||
Expect to eat dinner late... | Expect to eat dinner late... | ||
* | * Pick a page from [[:Category:Legacy To Do]] and make it better! Follow the notes given on the tag. | ||
* Clean up main topic pages. | * Clean up main topic pages: Find pages that have poor or outdated organization and re-organize, re-link to make it applicable to all versions. Make them useful hubs for information and quick reference. | ||
* Clean up tutorial pages: Try to make applicable to all versions, simplify them by judiciously editing and inserting of [[Legacy:Basic Procedure|basic procedure]] links. | * Clean up tutorial pages: Try to make applicable to all versions, simplify them by judiciously editing and inserting of [[Legacy:Basic Procedure|basic procedure]] links. If you can find a link to a UT200x version page, link to it. | ||
* Clean up images, make a list on [[Legacy:Images|Images]] of files we can delete (or delete them yourself) | * Clean up images, make a list on [[Legacy:Images|Images]] of files we can delete (or delete them yourself) | ||
** Find unused images | ** Find unused images | ||
| Line 40: | Line 49: | ||
** Find dross ([http://dictionary.reference.com/search?q=dross defined]) | ** Find dross ([http://dictionary.reference.com/search?q=dross defined]) | ||
* Find pages which essentially duplicate each other and merge them. After an old page has been merged, tag it with [[:Category:Legacy Delete Me]] and a brief explanation of why it should be deleted and where the info has been merged. | * Find pages which essentially duplicate each other and merge them. After an old page has been merged, tag it with [[:Category:Legacy Delete Me]] and a brief explanation of why it should be deleted and where the info has been merged. | ||
==Related Topics == | ==Related Topics == | ||
| Line 46: | Line 54: | ||
* [[Legacy:Project Discussion|Project Discussion]] | * [[Legacy:Project Discussion|Project Discussion]] | ||
[[Category:Legacy Wanted Pages|{{PAGENAME}}]] | [[Category:Legacy Wanted Pages|{{PAGENAME}}]] | ||
[[Category:Legacy FAQ|{{PAGENAME}}]] | [[Category:Legacy FAQ|{{PAGENAME}}]] | ||
Latest revision as of 14:17, 23 November 2005
The wiki is both your resource and your responsibility. Even if you have limited experience or available time, you can help.
Do one thing to help the wiki every day!
A wiki doesn't run itself. It's a bit like a garden: things grow, and you need to keep it tidy with a bit of trimming and weeding. Wikis rely heavily on Wiki:WikiGnomes to stay healthy.
This page lists things you can do to help. If you have a spare moment, there's always little things each of us can do that add up to make a big difference in the usability of this place.
Things To Do
Quick stuff
Got a couple of minutes? Click on Random Page and...
- Clean up any misspelled page titles: Put [[Legacy:Hello World|Hello World]], not [[Legacy:Hello_World|Hello_World]].
- Wikify new pages: Create inline links, add a "Related Topics" section, move any comments to a "Discussion" section.
- Tag long thread mode discussions with Category:Legacy Refactor Me and a brief note on what specific info needs to be merged with the page text.
- Tag pages that need obvious work with Category:Legacy To Do, include a brief description of the work needed as a note next to the tag.
- Tag pages with Category Tags from the list found in Category:Legacy Category. Tag class pages with Category:Legacy Class (UT), Category:Legacy Class (UT2003) or Category:Legacy Class (UT2004).
- Browse through Category:Legacy Category pages and identify those pages in every category that don't belong there; then either remove the wrong category links on those pages or "screen" them by adding an extra vertical bar at the end of the link, like
Category:Legacy Category. - Clean up class pages: (As an example, see MinigunAttachment. It was originally posted with only the Source Code.)
- Add class hierarchy bar at the top. (Example, {{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Pawn|Pawn]]}}: see Guidelines On Technical Names for more.) Include package name in parentheses.
- Add properties; Main and Hidden, including variable type and any remarks from the code.
- Add important or unique functions and events, try to include brief descriptions and the argument variables with variable types.
- Add states, try to include brief descriptions.
- Tidy up and update subclass trees, then tag with Category:Legacy Class Tree. (See NavigationPoint as an example)
A Bit Longer
About half an hour...
- Create a page that people have made links to, but which doesn't yet exist. Category:Legacy Wanted Pages gives a list of these. Or browse through Category:Legacy Class Tree pages and fill in important class pages that don't exist yet.
- Find WikiTags and deal with them:
- Category:Legacy Refactor Me tags: Clean up bits of discussion (MeatBall:ThreadMode) and refactor it into Wiki:DocumentMode
- Category:Legacy Link Me tags: Find the page the writer was thinking of and link it
- Category:Legacy Answer Needed tags: Try to answer the question the writer couldn't answer himself and integrate it into the page instead of starting to write in MeatBall:ThreadMode.
Big Jobs
Expect to eat dinner late...
- Pick a page from Category:Legacy To Do and make it better! Follow the notes given on the tag.
- Clean up main topic pages: Find pages that have poor or outdated organization and re-organize, re-link to make it applicable to all versions. Make them useful hubs for information and quick reference.
- Clean up tutorial pages: Try to make applicable to all versions, simplify them by judiciously editing and inserting of basic procedure links. If you can find a link to a UT200x version page, link to it.
- Clean up images, make a list on Images of files we can delete (or delete them yourself)
- Find unused images
- Find duplicates
- Find dross (defined)
- Find pages which essentially duplicate each other and merge them. After an old page has been merged, tag it with Category:Legacy Delete Me and a brief explanation of why it should be deleted and where the info has been merged.
Related Topics
- MetaTopics – all things to do with the wiki site itself
- Project Discussion
