My program doesn't have bugs. It just develops random features.

Category:Legacy Big Cleanup

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search

I shall be shortly embarking on a BIG clean up of the entire wiki (well, as much as I can face before giving up). Expect page renamings & upheavals. Feel free to disagree with my ideas, or improve them, or beat me to implementing them. ? Tarquin

OK guys: since you said you'd help, I've put a list here: UnrealWiki To Do.

Stuff to do[edit]

  • light work: find class pages and tag them as UT or UT2003 (see Class Tree for how)
  • look at what's been tagged so far – suggest improvements, or if you feel moved to go ahead & make changes, do so
  • find other pages that need work & tag them as "Big Cleanup"

Related Topics[edit]

Discussion[edit]

Piglet: Good luck :)

ZxAnPhOrIaN: Great job! I think that we have to merge repetitive pages and have a universal naming system. The terrain tutorials have to be cleaned up. Also, the pages that have techy stuff on it should have a suffix of "Tech". Finally, there should have an orpaned pages page here so that it could find a foster home.

Mychaeel: Everything here – with exception of personal rant pages – is "techy stuff." It's hardly of much use to give 90 percent of all pages the suffix "tech." – Besides, tarquin needs help, not good wishes.

ZxAnPhOrIaN: I will be glad to help (if i get time)!

ZxAnPhOrIaN: Should we have a signup place here?

Tarquin: I'd rather people just found things that need doing, or tagged pages that need work. We still have tagging of class pages to do, that would be good :)

Evolution: Well, I think attempting to categorize topics by UT / UT2003 / Unreal2 is a bad idea, simply because there is so much overlapping content. I think we should refrain from that, though we do need to come up with a standardization for content that *is* different b/t engine versions.

Mychaeel: We've started thinking about a good way to manage overlapping content even before UT2003 was released, but we couldn't come up with something that really appeals to us. Using namespaces was one suggestion, but obviously that only works if (1) content overlaps with a granularity of no less than pages and (2) overlapping content applies to all engine versions, not just some out of more. – Suggestions are still welcome.

Evolution: Does the wiki have the ability to hide/show content via links; something along the lines of "Show Me"/"Hide Me" links. For each topic's page that applies to more than one engine, there could be subsections that only apply to a specific engine version. These paragraphs are represented by a "UT2003 specified" link normally. When you click the link, the paragraph expands inline with the text to display the UT2003-specific info.

Piglet: I am entirely happy to help, and I dont see why that means I cant also wish Tarquin luck. If it sounded like "I'll just sit back here and wait for it to be done" then I apologize, it is not how i meant it at all.

Tarquin: well not much activity so far.... Maybe we should set up a permanent UnrealWiki To Do page with ideas of what people can do to help out, like they have on MeatBall:MeatballToDo

Tarquin: Okay, all those people who said they'd help ... list of thing to consider doing on Unreal Engine.

Ben 2500: Ill help :)

Wormbo: I'll fix whatever I run into, at least if I have the time to do it.

Anthony: I'd love to help. Unfortunately I have very little practicle experience with the Unreal Engine. I have however been studying unrealscript and the general way in which things fit together for a while. How can I make myself useful?

The topic pages[edit]

Mych: Maybe we need a naming convention for forward indices ("Topics on Mapping", "Topics on Coding", and so on, for example?) with a "Category Topics" to go along with it.

Tarquin: We could standardize the names of the "topic pages". I think "Topics on foo" doesn't read as well as "foo topics". But I guess it boils down to: what will people spot most when they search? are they looking for the word "foo" or "topic"? Home Page is a forward index for topic pages, but there's no harm in giving a reverse index as well. :) I'm thinking Application is a needless forward index, because it's such a general grouping. People are interested in apps for a particular purpose: IDE, texturing, modeling, text editors, etc

Mychaeel: But "Topics on Foo" pages are neatly listed one below each other in an alphabetical listing such as a search result, which is the whole point of naming similar pages (or variables, or classes) starting with the same prefix. Like "Mapping for Foo" and "Mapping for Bar." Maybe "Pages on Foo" alternatively. – Application might have subpages, for that matter.

Tarquin: ok. point taken, let's do that. I'm off for a walk now, but what I suggest is: rather than rename what we have, let's make a list of what we think we need. Let's just draw up a list of "Topics on foo" pages we think are good to have, based on what we think should be available rather than the material we have. Then I'll figure out how to match what we have to that list.

Mychaeel: That sounds like a much better approach than trying bend the existing pages into shape.  :-)

Tarquin: well... I'm hoping people OTHER than me help write this list, otherwise what I devise will be pretty much the topic grouping we currently have.

Tarquin: Looking great! and it fits in nicely with the planned split of the Applications page.

List of Topic pages[edit]

A list of suggested Topic pages to form the level of the page hierarchy below Home Page. Please add, change, discuss...

  • Topics on Coding
  • * Fundamentals – OOP, downloadable sources, ...
  • * Setup – editors, compiler wrappers, IDEs, ...
  • * Extending the Game – making mutators, game types, GUI, ...
  • * Networking – replication, client-side Interactions, ...
  • * Reference – class tree, UnrealScript reference, grammar, ...
  • * Tools – redux from Setup
  • Topics on Mapping
  • * Layout Design – planning, layout, gameplay and flow, ...
  • * Construction – BSP, terrain, static meshes, skyboxes, PlayerStarts, ...
  • * Visual Design – using textures, lighting, materials, ...
  • * Bot Support – pathing, jump spots, doors, ...
  • * Interactivity – triggers, custom components, ...
  • * Tools – Toolbar Creator, custom brush builders, MeshMaker, ...
  • Topics on Modeling
  • * Fundamentals – vertex meshes, skeletal meshes, static meshes
  • * Importing Models – weapon models, player models, static meshes, ...
  • * Tools – MeshMaker, MilkShape, ...

Wormbo: Those categories have serious issues with newbie friendlyness. I wouldn't care about architecture or visual design if I wanted to learn mapping. At first my only concern is: "How do I use this thing?"

Tarquin: We can try and make a decent Mapping Lessons page. After all, I think UnrealScript lessons is pretty good now :) (and we could rename it "Coding Lessons"

How to present them[edit]

Several possible ways to do this.

Option 1: 4-tier

  • Home Page
    • Topics on Mapping etc
      • Building Worlds
        • Actual page

Option 2: 3-tier, small HP, big topics

  • Home Page
    • Topics on Mapping etc
      • Actual page

Option 3: 3-tier, large HP, small topics

  • Home Page, clearly divided into sections "Topics on mapping", coding etc
    • Building Worlds etc
      • Actual page

Mychaeel: I think up to a certain degree people prefer pages with more content to take in at a time over a finer-grained structure of pages. I think the topic pages outlined above can each be one single page with several subtitles (as illustrated by their subitems above). Those sections on the topic pages should be a simple bullet list with links and a short description for each:

The links to those topic pages on the Home Page in turn follow the same scheme, just on a higher level:

  • Topics on Coding – fundamentals, setting up a scripting environment, extending the game, tools
  • Topics on Mapping – architecture, building worlds, visual design, bot support, interactivity, tools
  • Topics on Modeling – mesh types, importing models, tools

That's a bit like Yahoo's front page – links to sections along with a sample of what they contain.

Tarquin: That's option 2 above. on the one hand, the problem with option 3 (much like what we have) is that some topic pages are very brief, some (architecture) very long. and with option 2, as Zxan's Mapping Resources page shows, we could get REALLY big pages.

Mychaeel: Then there's need of more "topic" pages that are, however, not necessarily called that way. Looking at Mapping Resources I think all the stuff on brushes (building, saving, transforming) warrants its own page; so do all the mod mapping pages, and apparently the "dynamics" part too. I thus propose that we simply remain flexible: If a "Topics on Foo" page becomes too crowded, just see to it that related links are bundled to more specific pages. The "Topics on Foo" pages are merely the first tier.

Tarquin: It'll be very strange (to me) having such a slim home page! I think Topics on Mapping will end up being a slim list itself of further pages. I really like the division of topics, just unsure about the depth of hierarchy this is going to produce:

Home page -> Topics on Mapping -> Visual Design -> specific page on textures

Tarquin: where does Karma fit into the topic hierarchy above?

Foxpaw: I'd say Karma is more a topic on coding than mapping.. though mapper can insert them into their levels they generally require a relatively small portion of the capabilities of the Karma physics engine. (For meat, or fans, or swinging doors, or whatever.) Perhaps there could be an overview of Karma in the mapping section and the remainder in the coding section?

Foxpaw: I like option 3 of the above ones, but I think that there should be a bit more separation between topics. Extending the game could be broken up into a section on general modification and more technically involved things - most of the mods that are made don't require quaternions, complex karma physics, complex vector maths, native functions, or any of that fun stuff, so including it in the same section as the more basic parts of making gametypes, etc. might add confusion. If they went into "Extending the Game" and the first page they clicked on was quaternions, they might be frightened away from unrealscript as a result. (Unless someone were to refactor the page into something less excessively complex.)


Mychaeel: I got the following email on Friday, forwarded by larrystorch, from somebody going by the nickname of Koosh_Ballz.

The innerbox template is only supposed to be used by the converted content imported into the Legacy: namespace. You might be looking for the Quote template instead.

Tarquin: It's unlikely we'll set it out like that. But we should do something about the UT / UT2003 thing. I think that the default is (should be) ut2003. We need to mention that somewhere.


Mychaeel: I just filled in Create a Mover which tarquin had left as a stub with the comment "needs work." All I had to do was filling in three simple, single-line steps.

Really: We'll never get anywhere with this "big cleanup" if we don't start finishing things instead of leaving them routinely unfinished in the hope that "somebody else will fill it in." Bringing a page into a usable state instead of leaving it unfinished may take only a few minutes more, but unless it is done it is just yet another thing on our endless cleanup to-do list. We won't ever get anywhere if we add things that need cleaning up in a higher rate than we actually clean them up.

What's needed here is a change of attitude, not Yet Another Plan. The slogan "Leave it unfinished, somebody else is bound to fill it in" that was advertised so often in the early days of the Unreal Wiki (and our own Wiki experience) simply doesn't apply anymore, if it ever really did. You must consciously force yourself to stick with a page long enough to leave it in the state you'd like to find it in if you were looking for the information its page title promises. It usually really doesn't take much more than an extra minute, but it'd be well worth it.

Tarquin: I think it's the other way round. We don't have enough of a "wiki" mindset here, but rather than adapt to that and stop working in a wiki way, I would like to change the minset. Plenty of people visit this site all the time. Why aren't they helping? It shouldn't be down to just me, you, Wormbo and Entropic when he gets away from the kids! :(

OBWANDO: I visit just about every day, and add what I can... First thing I usually do is check the recent changes, and then look around to see what I can fix up or so. I havent found a 'to do' page that has places that need to be fixed/etc... If it were there, it would be easier to go to it and do some work instead of spending time trying to find the work to do. Anyone that finds an area can add to the 'to do' page and when finished, should put a **DONE** in front of the header. If not, let me know how I can help.

Wormbo: The To Do page is Category:Legacy To Do. It lists all pages that need further work. If a page doesn't need further work anymore, just remove it from the category by removing the category link.

Sobiwan: I have been using WIKI as a reference for a while, but never figured out what a WIKI was until recently. The process I went through is:

  • Great reference!
  • Why are some pages unfinished?
  • Where are some of the pages?
  • Why are there conversations at a reference site?

I finally decided to read the Wiki Community] and it all made sense. Knowing that I love to explain things and know UED pretty well, I wanted to contribute, but that raised an important question, which brings me to this page:

What format will be used?

This cleanup and to-do is a result of one of many things:

  • There was no format
  • There was a format but few adhered to it because:
    • They didnt know about it
    • They were lazy
  • Everyone had their own format

I have yet to see a standard format for the Unreal WIKI pages, but that might be due to my ignorance. On the few pages I've altered, I've used my best judgement for a format using particular existing pages as a template. I believe the format must be first be defined, then shared among the contributors. An example of a format:

  • General description
  • Process
  • Tips to make the process easier
  • Problems
  • Related Topics
  • Comments
  • Page Tagging

There is also the issue of when to use certain Wiki Markup. Some people may not know when to use a definition list versus a subsection because they havent thought about what their text is structured as. WIKI can be involved before starting, but the effort to define these issues results in less activity in UnrealWiki To Do.

Of course, the entire site is one big dynamically structured hierchy, so even that has to be defined. Like "Koosh_Ballz" said in his email, sometimes he found that certain things applied only to UT2k3 when he was looking for UT2. I had that same problem. Proper tagging and structuring solves this.

This category currently contains no pages or media.