Ultronomicon talk:Manual of Style

From Ultronomicon
Revision as of 06:18, 6 July 2007 by 200.83.4.5 (talk)
Jump to navigation Jump to search

I haven't really contributed much, but I added just a few things to this style guide based on what I've seen around Ultronomicon. Please feel free to edit the guide and discuss anything that you disagree with here. Thanks! --Phoenix (t) 22:53, 4 Oct 2005 (CEST)

Language

I wrote American English just because I've seen most articles using it. I personally prefer to use British English, so I will not object if we decide to use that instead (in fact, I'd enthusiastically support the use of British English). --Phoenix (t) 22:53, 4 Oct 2005 (CEST)

I unfortunately have to agree. I prefer British English in general myself, and I'll do use it on the talk pages, but the game itself is in American English, and as such American English seems most appropriate for the actual articles. -- SvdB 20:59, 8 Oct 2005 (CEST)
Ah yes, I didn't even think of that. --Phoenix (t) 19:05, 10 Oct 2005 (CEST)

General style guide comments

If this style guide is going to stand a chance of actually being read, it's got to be a lot more terse. With that in mind, I'm going to be bold and scrap the entire introduction, which is just stating the obvious.

I'll update the style guide to address your "(disputes)" which are probably satisfied here. --Phoenix (t) 15:38, 11 Oct 2005 (CEST)


Side boxes

I also think the explanation on the various side boxes does not belong on this page. Ultronomicon:Templates perhaps, or else a new page. This page is about style, not a technical manual.

However, I think we need an explanation on the use of the {{RaceBox}} template, because these boxes need to be consistent. Some of the fields could be filled out in different ways: I think the style guide should specify how this box is filled out.

About the side boxes, I agree that people should know it, but to keep this page readable, I suggest to only make a reference here, and point to a page that contains the details. Something like "The various side boxes need to be filled in correctly and consistently. Read <this page> to see how it is done."

I disagree about moving the side boxes to another article linked from the style guide. I think the style guide should be a reference. It can be read from top to bottom if desired, but it's not really designed to be as such. I see the style guide as something that writers and editors refer to if they have a question about how to write content. I think all the data should be on one page. Having to click a link to get to more content is difficult, and it is also annoying when one wants to print out the page to have a reference with which to edit content. The TOC contains hyperlinks to all the relevant sections, and as long as the headings are verbose enough, I think that should be sufficient for the writer or editor to refer to the correct section.

About the side boxes: To be complete and consistent, we'd want to explain how all the various race boxes work. Consider how large this page would become then. I agree that they should be described, but I don't think it should be on this page. A remark here "For consistency, it's important that the various templates are filled in in the same way. The page ... explains how they are to be used." would do the trick imho. Having a separate page allows the reader to find specifically the information he's interested more easilly. Also, when someone reads the entire page from top to bottom, which imho is something all contributors should do, he/she won't remember all these details anyhow. The template stuff is more of a reference thing that people should know where to find when they need it, not something that is vital that they know when they start editing the Ultronomicon. Most starting editors won't be adding side boxes anyhow.

Do you mean we'd have to explain how all the various sideboxes work? If so, right now, I can only think of two: the {{RaceBox}} and the prototypical {{ShipBox}}. I think the presence of just two boxes should be okay. If the number of side boxes requiring a style guide entry reaches an unmanageable size, I'd agree, but right now, I only see two side boxes that require such an entry, and the style guide can easily handle a few more. In addition, I don't think all fields require an extensive entry. When I get around to expanding the ship box template to include details such as turning rate and battery regeneration, I can just lump all these together into one entry and say "specify the integer as noted in the source code", or something like that.

The Flagship/Vindicator

We should also stick to one "name" or for the flagship, to keep things clean. I'd say "The Flagship" when used as a title (which it is in most of the cases where you'd want a wiki link). When used as a description it should be lowercase; you'd just be using it as an English word. Suggested phrasing: Use "The Flagship" (note the capitalisation) to refer to the one and only Precursor ship controlled by the player. When refering to the ship by description, used "flagship" as you would in any other English text. Similarly, we should stick to one way of writing "The Captain".