Talk:Worms Armageddon ReadMe (English)

I'm putting the readmes for each version on subpages, else this page is going to be insanely huge Run! 15:16, 25 June 2008 (MST)

Remind me why do we even have to put the English ReadMe on the wiki --Vladimir 03:42, 26 June 2008 (MST)

It's a convenient place for reference, also it would help with translation projects if people could simply keep a section of this page open in a tab while translating into another page. I'd find this useful if i want to look something up anyway (which i sometimes do and can't be arsed to go trundling into my WA folder to find the readme).

Though perhaps more useful would be sorting all the changes, particularly the features, into their respective department (maps, chat features, interface and stuff) but that would take forever so probably won't happen for a long time. Run! 08:22, 26 June 2008 (MST)

Page title

Can we also translate the page title of the readmes, so that we may have something like "Worms Armageddon 讀我" as a page title instead of "Worms Armageddon ReadMe (Traditional Chinese)"? —Explorer09 06:33, 20 January 2010 (UTC)

Automation

Before anyone spends a considerable amount of effort on these pages, please be informed that I've written a program which can parse the ReadMe and output text in a variety of formatting, including MediaWiki. I plan to run the latest ReadMe through the program and merge the content of existing pages with that generated by the ReadMe, and automate any differences, to allow easy maintenance in the future.

Explorer seems to think that the blue formatting used in the ReadMe should be removed, because it can be confused with links. I suggest replacing it with another shade of blue.

Bells and whistles such as templates for the [CS/DC] tags are nice but not really necessary, considering that the maintenance will be mostly done by a program.

Thoughts? --Vladimir 19:11, 26 October 2010 (CEST)

Um, are you talking this with me? Anyway, here are my thoughts...

• The blue formatting is easily be confused with links - that's real. I forgot to tell you about this before the release of the update. My idea was to avoid text coloring in WKB (or other online places, including the forum) and try another kind of emphasis. However if you still like coloring, how about using green or teal? Any shade of blue is still confusing. Purple too. (← You'll know what I mean if you click the colored text unintentionally)
• For the [CS/DC] templates, first if you looked at the template code of those tags, you could see that I added rollover titles. (sample: [CS] [DC]) Second, I believe that using templates would be more readable in page source

* {{CS, DC}} Hardware and Operating System compatibility
** {{CS}} Windows 98/ME compatibility, which was accidentally broken in v3.6.29.0, has been restored.
** {{CS}} Minimisation support in the front end in Windows Vista was incomplete (upon restoring, it
 was not possible to interact with UI elements using the mouse).
** {{CS}} W:A now uses a new method of restoring the palette, which has been found to be more
 effective on Windows Vista and Windows 7. Should the display palette become corrupted, the user can try to
 restore it manually in-game by pressing '''Shift+Pause'''.

rather than

* <small>[CS, DC]</small> Hardware and Operating System compatibility
** <small>[CS]</small> Windows 98/ME compatibility, which was accidentally broken in v3.6.29.0, has been restored.
** <small>[CS]</small> Minimisation support in the front end in Windows Vista was incomplete (upon restoring, it
 was not possible to interact with UI elements using the mouse).
** <small>[CS]</small> W:A now uses a new method of restoring the palette, which has been found to be more
 effective on Windows Vista and Windows 7. Should the display palette become corrupted, the user can try to
 restore it manually in-game by pressing '''Shift+Pause'''.

--Explorer09 01:45, 27 October 2010 (CEST)

Yes, I know, the templates are nice. Teal isn't a shade of blue? I meant something like that. Green looks nice too. --Vladimir 04:31, 27 October 2010 (CEST)

One more thing. You can go ahead and use the program, but would you please leave a message in the edit summary like "wikified using automated program/bot" or such? --Explorer09 02:17, 27 October 2010 (CEST)

Sure, there'll be a comment at the start of the page too. --Vladimir 04:31, 27 October 2010 (CEST)

---

OK, moving this forward... I would like the process to be 100% automatic, so that the Wiki version can be kept in full sync with the official ReadMe. Edits to the Wiki pages will be either included in the official ReadMe, or discarded.

What are the things that I'd need to be aware of when doing the automatic conversion of the ReadMe?

• Obviously, preserving existing layout (header and nav footer)
• Replace "blue" colour with teal
• Replace [CS/DC] tags with template instances
• Replace references to footnotes and sections with wikilinks

Anything else? --Vladimir 09:07, 27 October 2010 (CEST)

Maybe this: I used Template:Lowlight for small gray text like (introduced in <version-number>). Would this template be used during conversion? --Explorer09 10:41, 27 October 2010 (CEST)

Yes, but I think "Lowlight" is a misnomer. A semantic name would be better, I think, such as "Remark" or "Note", or even a customized "ImplementedIn" for this purpose.

Umm, Explorer, why do you continue to manually transcribe ReadMes even though I'm going to automate this soon? --Vladimir 13:59, 27 October 2010 (CEST)

I'm stopping now. --Explorer09 14:21, 27 October 2010 (CEST)

OK, though you may want to talk to someone about that wikiholia ;)

FWIW, the source code of the program will be made available. --Vladimir 15:21, 27 October 2010 (CEST)

It is done.

Source will be posted later.

Note that bot edits do not show up in Special:RecentChanges and RSS by default. --Vladimir 08:00, 20 March 2011 (CET)

CSS

I wonder if I am allowed to add these CSS selectors (classes). I hope these will help the automation a bit.

CSS selector	What was displayed in the readme	What will display here
.readme-blue {color: teal;}	sample	sample
.readme-red {color: #800000;}	[Blah; see <version-number> fixes]	[Blah; see <version-number> fixes]
.readme-green {color: green;}	sample	sample
.readme-smallgray {color: #7D7D7D; font-size: 84%;}	(introduced in <version-number>)	(introduced in <version-number>)
.readme-devtag {font-size: 84%;}	[CS, DC]	[CS, DC]

--Explorer09 02:30, 22 November 2010 (CET)