Documentation

Cammagno said:
They are not so similar, because they show the effect instead of the status and the don't have icons as headers (at least, if you don't have changed them in this last upload)
Plus, there are also the columns for civ-specific buildings which appear only if the right civilization is played
Click to expand...

:lol: I'm having a hard time remembering what they original CDA had and comparing it to what I added. I guess I gotta bite the bullet and open up the old version of the code. Maybe I'll just take what you wrote in your previous post.

Cammagno said:
there are two series of resource columns, both with icons as headers, one showing effects and the other one showing availability.
Click to expand...

Yup, I forgot to do those entirely. Good thing we aren't pressing this thing onto a CD. :)
 
This is why writing documentation is over-rated. It just leads to problems and slows down the 'having fun with code' stage. The other option is that you only ever work on really really small projects that don't need any documentation. Or, you just work with really bright people that don't need documentation (as long as they don't disagree with you - bright people that insist on seeing things differently ... wrongly ... can be a real pain).
 
Since I can't edit files on GoogleDocs, I'll address the comment about Attitude in the Title here. Yes, we only included Attitude Icons, but the original code ot add attitude to the score at all was SimCutie's doing. Without that, there would be no attitude icons. If that's removed, then a few other thing shouldn't be included either.
 
alerum68 said:
The original code ot add attitude to the score at all was SimCutie's doing.
Click to expand...

Thank you for that info. The first I heard of SimCutie's work was when it was included -- along with Attitude Icons as mutually exclusive options -- in Nevermind's Main Interface Mod. I just assumed they were two completely unrelated (as in codebase) mods. I have no problem leaving it in, just like BES and EFA given that they are part of BtS now. :)

Also, is the problem with GoogleDocs on your end? I added you as a collaborator. Did I goof it up?
 
Alright, I'm confused about something... we have EFA in our documents, but IIRC we didn't add any of it's features because it was already added into BTS. Now, if we haven't we need to remove EFA.rtf from the documents, and just change it to Ruff's Glance Screen. Is this correct?

Also since we aren't using PLE, but using Ruff's version how should we handle this? It seems that Ruff built it from scratch, so the credit should go to him completely. but it was 12monkey's idea to start with. I also think we should change the name to Improved Unit Icons.

Also noticed we don't have any docs for Civ4lerts.
 
alerum68 said:
Alright, I'm confused about something... we have EFA in our documents, but IIRC we didn't add any of it's features because it was already added into BTS. Now, if we haven't we need to remove EFA.rtf from the documents, and just change it to Ruff's Glance Screen. Is this correct?
Click to expand...

Yes, we can do it. To do t, we need a readme for Ruff's Glance Screen, in which some credit is given to the original author.

alerum68 said:
Also since we aren't using PLE, but using Ruff's version how should we handle this? It seems that Ruff built it from scratch, so the credit should go to him completely. but it was 12monkey's idea to start with. I also think we should change the name to Improved Unit Icons.
Click to expand...

I agree, but again we need a Readme with credit to the original author. But in this case, I'll suggest to wait till when more PLE stuff is added.

alerum68 said:
Also noticed we don't have any docs for Civ4lerts.
Click to expand...

Yes, we don't have any.
 
Yeah, but you don't know Italian, and that is what we need here.:p I'm going to need him to translate again.... hopefully this will be the last time.;)
 
alerum68 said:
Cam, do you have an html editor, or know html code?
Click to expand...

Yes, no problem with html :)

But before you ask for something ;) I have to tell you in advance that till 15 of december, all my time is taken by a big project at work. :(
After that date, anyway, I'll have my free time back, so I'll be able to do whichever is needed :)
 
Don't worry, I won't have the project I'm working on done until that time frame so it should work out perfectly. You may need to learn a new program, but it's got a very simple interface, and I can walk you through it.
 
Okay, I'm almost done with the document project. I have 2 plans for this:

1) The .CHM file so we can get rid of the Documentation folder. Like I said we'll need the Italian and German Translations to be ported over to HTML.
I know it's going to be a pita, but the way it needs to work to keep it looking good is to translate the main help files over again. There maybe parts where I copied completely from the old docs, but I think I rewrote at least half of it. The Included Mods can pretty much just be looked at, and copied straight from the already completed translated Docs. I don't think I updated any of it.
I tried to keep as much info as I could, but we may want to change the format around a bit.
Now 2 options for how we do the translations as well. We can install 3 different .chm files or I can create books within the help file that will have Italian and German translations within it, and have English just open as the default book.
I'm hoping Ludwig II is still around, and willing to help with the German translations.

2) Online Docs. I'm going to wikify the html and post it on sourceforge. I'm doing this hoping that the Coders will get in the habit of updating wiki as soon as a major code change is made.

The BUG Structure file I won't be including, but will be putting up on our website as a What is the BUG Project? page. I'm having trouble on where to put the BUG Structure doc. It will be on the Wiki, but not sure how to put it in the help file. Maybe as a chapter in the Installation area?

And we really need some basic FAQ. I think this needs to be a 2 man project... one person to search the thread and compile a list of questions that we get asked alot, and another to answer the questions. This is just a very large project for 1 person to handle alone. I'll handle 1 half, but need someone to take the other. Any takers?:)

Anyway, I'm looking for your input here Cam and Ludwig. EF will just do what we tell him with the docs, so don't worry about him.:p I know you can touch this for another week at least Cam, but we should start planning as soon as you're able.
 
alerum - do you have a link to the wiki?
 
The wiki hasn't been started at all yet, but the link for it will be: http://civ4bug.wiki.sourceforge.net/. No need to worry about editing it yet... I'm going to convert the HTML for the help file over to the wiki, then we can organize it. Also, is there a way to call the help file from within the Options screen?
 
I don't know if we can open the help file inside Civ. We could possibly launch the file from it in Windows, and hopefully the game would minimize to show the help file.
 
I think we'd have to pray for the blessings of Allah on this one. I haven't seen any functions that allow direct control. That being said, we pulled in the Windows Registry Python library, so I don't see why we couldn't do the same for launching a help file and minimizing the game.

Windows-only, of course, but so is the help file, right?
 
Okay, hoping you guys are about ready to translate the help files.;) Right now it needs to be updated with the additions since it was first put together. I haven't been keeping it updated, so there are going to be some goodies to add.

Alright, for the translators:

The Help file is will probably be easiest to work this way:

  1. Download the current files I have on the SVN in the Help Files/BUG Help/Source. (For now, don't worry about the online help. I'll have to figure that out later.)
  2. It's already formated into the most common format for help files, so don't change any formating please. This includes file names.
  3. The htmls in the root "source" directory are the main help files. The directories below it, are like chapters, for the Included Mods, and the Options screen.
  4. I tried to include as much information as I could from the original modders docs, so in some cases you may want to go look through old translations, and just copy and paste. Those are located in either the ITA or the DEU directories. We do not have any French translations to work off of yet. Sorry Falc!
  5. If you want to expand on the english help files, I'm all for it, just make sure to post in this thread beforehand, so we all have the same thing to translate from.

Let me know if you have any questions.:)
 
You must log in or register to reply here.

Similar threads

R
Modding Help - Change difficulty settings depending on era
Replies
1
Views
675
Taefin
Taefin
O
Tool - Civ4 BTS Map Validator
Replies
0
Views
643
onkelm
O
R
[C3C] Civ3 Wonder Tennis Court and Tournaments Graphics Creation Guide
Replies
2
Views
473
rukasujjk
R
Eyswein
7otM05 Announcement
Replies
6
Views
2K
leif erikson
leif erikson
W
Scripting Runtime Information
Replies
19
Views
2K
LilBudyWizer
LilBudyWizer
Back
Top Bottom