View Full Version : Documentation
Cammagno Sep 03, 2007, 01:24 PM @Alerum
Great idea to move the list of included mods from BUGReadMe.rtf to the new BUGModsIncluded.rtf
I did the same for FBUG, creating FBUGModsIncluded.rtf and modifing FBUGReaMe.rtf (removing the list and adding the reference to FBUGModsIncluded.rtf).
I'm about to update the italian version of all these docs.
@everybody
what about changing the names of the release files from TheBUGMod1_00.xxx to something like BUG_100.xxx and from TheFlavorfulBUG1_00.xxx to FBUG_100.exe?
alerum68 Sep 03, 2007, 03:28 PM I was thinking abotu the same thing Cam. I don't think we need the full name for people to remember anymore. I'm also thinking of not including a .zip of the FBUG, and just having the install.
Cammagno Sep 03, 2007, 03:39 PM I was thinking abotu the same thing Cam. I don't think we need the full name for people to remember anymore. I'm also thinking of not including a .zip of the FBUG, and just having the install.
Uhm... I don't know, I usually like the zip versions, because I like to have more control and knowledge :D Probably I saw too much "X-Files" :lol: but I prefer to know what a program is doing in my PC :)
So, may I suggest to leave zip version alive at least for major releases?
Cammagno Sep 09, 2007, 02:25 AM What about making "sticky" the "Request for new components" and the "Questions about the BUG mod" (it is 'queStions' :crazyeye: ) threads?
alerum68 Sep 09, 2007, 11:44 AM I can't believe I made that typo! I'm usually pretty good about catching that. Alright, is not a bad idea. Will PM woodelf about it now.
EmperorFool Sep 15, 2007, 08:20 PM I'm updating documentation (no really!) and cannot find who created the original City Cycle Arrows and GPBar. If someone remembers or can find it, please update the docs.
Cammagno Sep 15, 2007, 11:37 PM I'm updating documentation (no really!) and cannot find who created the original City Cycle Arrows and GPBar. If someone remembers or can find it, please update the docs.
I don't remember, but I'll try to find it.
When you have time, please look at IncludedModsVersion.xls (in the main folder) and help me to fill the empty boxes (for almost all of them, you only have to put in a VN for mod created or modified by you :) )
alerum68 Sep 16, 2007, 09:08 AM City Cycle is SimCutie... don't know the GP Bar.
EmperorFool Sep 17, 2007, 02:58 AM I've updated the changes doc. The only one left to write up is Autolog, but I can't think of what major things I changed. I think all I did was have it look for the log file elsewhere, but that's not very exciting. What else? Ruff?
I was looking at the files and thinking ... spaces? Why does each start with BUG when they're in the "BUG Documentation" folder? :)
Perhaps...
Changes
File Organization
Features
Included Mods
Read MeAlso, should we merge Changes into Included Mods since we'll need a Changes document for future releases -- changes we've made to OUR mod, not the included mods. Just a few thoughts. I'm not attached to either way ('cept the lack of spaces maybe, even the GPL file gets spaces :rolleyes:).
Cammagno Sep 17, 2007, 05:50 AM I've updated the changes doc. The only one left to write up is Autolog, but I can't think of what major things I changed. I think all I did was have it look for the log file elsewhere, but that's not very exciting. What else? Ruff?
I was looking at the files and thinking ... spaces? Why does each start with BUG when they're in the "BUG Documentation" folder? :)
Perhaps...
Changes
File Organization
Features
Included Mods
Read MeAlso, should we merge Changes into Included Mods since we'll need a Changes document for future releases -- changes we've made to OUR mod, not the included mods. Just a few thoughts. I'm not attached to either way ('cept the lack of spaces maybe, even the GPL file gets spaces :rolleyes:).
I like spaces also, but Alerum didn't wanted them for some reason that I don't remember... if that reason is not there anymore, we can put them in.
About BUG in the name... I think it's better to leave it, maybe as a tag [BUG].
About merging Changes with Included Mods, I'm in favour of it.i also want to merge with it the file with the version numbers, when it is filled with the missing VN.
We have to pay attention to change accordingly all the docs which have references to them.
I can take care of these things this evening (now it's 14 o'clock here).
alerum68 Sep 17, 2007, 07:43 AM The reasoning is SF is picky about spacing when first set things up... kept getting errors anytime I'd upload a file to it when I first got it going. Go ahead and make the changes, and see if the commit okay.
I do agree with EF about removing BUG from the name on all but our Read Me file, just to be safe.
EmperorFool Sep 17, 2007, 10:40 AM I think you were having trouble with spaces only when uploading the installer/zip? I remember that we were talking about how to format the version number at the same time, and that only appeared on the ZIP. In any case, other files have spaces so we should be good there.
I see the reason for leaving BUG in. If you do, just leave it as BUG, don't add []s or anything. "BUG Read Me" is fine as are the others. But do note the other name changes (e.g. Dir is a little obtuse).
Okay now I really need to get ready for work!
Cammagno Sep 17, 2007, 02:12 PM I see the reason for leaving BUG in. If you do, just leave it as BUG, don't add []s or anything. "BUG Read Me" is fine as are the others. But do note the other name changes (e.g. Dir is a little obtuse).
Ok, I've renamed all the docs files, both for BUG and FBUG (another reason for leaving "BUG" and "FBUG" before the names is to differentiate them).
I also updated all the English docs fixing the references to other files and merging Changes files into Included Mods files.
I still have to update the Italian files, but I'll do it.
Note that for now, FBUG docs are only related to the Flavor stuff, if we want (as I suppose) to release FBUG as a pack including BUG, these files need a bit of updating (for example including BUG files inside FBUG Structure.rtf).
Cammagno Sep 18, 2007, 01:03 PM Ok, I've updated all the docs (for BUG and FBUG) to reflect the new independent nature of the two mods.
Please check my English :blush:
I've a bit more work to do on the Italian docs, but the documentation is almost ok now.
The only things needed are the following:
- the FBUG Included Mods.rtf is without the section about the changes made by the BUG Team to the original mods (as the relative section in BUG Mod)
- the French Readme.rtf need to be updated to match the English one.
Cammagno Sep 18, 2007, 02:01 PM @EF
I've just translated your Changes section. Everything is ok, but a couple of things about CDA seems a bit strange to me. :blush:
#####
- Added a set of building class columns that show the building type for the civ you're playing.
- Added a second set of building type/class columns that show if you have the building or not instead of the effects of the building. These columns are narrower than the originals.
#####
It is not a new set of columns, if I'm not wrong, it is the same... we have two sets, the original ones (specific buildings with effects) and the new one (class building with status).
If I'm right, I'll suggest something like this (maybe in a better English :lol: ):
"Added a set of building class columns that show the building type for the civ you're playing. These columns show if you have the building or not instead of the effects of the building (which anyway are showed placing the mouse cursor over the icons on the top of the columns), so they are narrower than the originals."
#####
- Changed all building columns to use the building's icon instead of its name.
#####
Did you added the building icons to the normal building columns? If the answer is yes, I haven't realized it yet :blush:
You have also added the civ-specific building columns, no mention about them?
#####
-Resource columns now show their icon as the header and the effects as the value.
#####
To tell the truth, we have two series of resource columns, both with icons as headers, one showing effects and the other one showing availability.
EmperorFool Sep 18, 2007, 09:05 PM That's the problem with writing docs long after doing the work. :( Good catches, and I'll update the comments and the docs tonight or tomorrow. I think you're correct on each item you mentioned.
EmperorFool Sep 23, 2007, 02:04 PM Happy International Documentation Day!
:clap::woohoo::rockon::band::beer:
NikNaks Sep 23, 2007, 02:36 PM What?? Is it today? I can't believe I forgot :lol:
EmperorFool Sep 23, 2007, 04:52 PM I've finally written docs for the mods I created. Deadlines are great motivators. :) Please let me know if I missed any. Yes, I'm so lazy I'm asking you to tell me if I missed any mods that I created. :mischief:
BTW, Impaler[WrG] did the Great Person Bar, but I couldn't find a readme for it. I think he may have created it when he added some other stuff to MainScreenMod.
Cammagno Sep 23, 2007, 11:52 PM That's the problem with writing docs long after doing the work. :( Good catches, and I'll update the comments and the docs tonight or tomorrow. I think you're correct on each item you mentioned.
Still a couple of little things that are not fully correct about these :blush:
#####
Added a set of building class columns that show whether or not you have constructed the building type (based on your current civilization) for that class. The headers for these columns are the building icons.
Added a set of building type columns similar to the above columns.
#####
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
#####
Resource columns now show their icon as the header and the effects as the value.
#####
there are two series of resource columns, both with icons as headers, one showing effects and the other one showing availability.
EmperorFool Sep 24, 2007, 04:16 AM 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
: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.
there are two series of resource columns, both with icons as headers, one showing effects and the other one showing availability.
Yup, I forgot to do those entirely. Good thing we aren't pressing this thing onto a CD. :)
ruff_hi Sep 24, 2007, 11:30 AM 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).
Cammagno Oct 08, 2007, 02:37 PM All the docs are updated and ready for the BUG 1.1 and BAT 1.0 releases :)
alerum68 Oct 10, 2007, 06:35 PM 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.
EmperorFool Oct 10, 2007, 07:48 PM The original code ot add attitude to the score at all was SimCutie's doing.
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?
alerum68 Nov 29, 2007, 11:06 PM 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.
Cammagno Dec 01, 2007, 12:20 AM 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?
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.
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.
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.
Also noticed we don't have any docs for Civ4lerts.
Yes, we don't have any.
alerum68 Dec 01, 2007, 10:26 AM Cam, do you have an html editor, or know html code?
NikNaks Dec 01, 2007, 10:39 AM I have one and know the code. Try Nvu if you need a good free one.
alerum68 Dec 01, 2007, 10:43 AM 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.;)
Cammagno Dec 01, 2007, 10:49 AM Cam, do you have an html editor, or know html code?
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 :)
alerum68 Dec 01, 2007, 10:59 AM 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.
alerum68 Dec 09, 2007, 12:43 PM 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.
ruff_hi Dec 11, 2007, 01:39 PM alerum - do you have a link to the wiki?
alerum68 Dec 12, 2007, 07:32 AM 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?
EmperorFool Dec 12, 2007, 02:11 PM 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.
alerum68 Dec 12, 2007, 07:17 PM That's actually what I meant. Can we trigger the game to minimize when the help file is selected, or just pray that it does?
EmperorFool Dec 12, 2007, 10:16 PM 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?
alerum68 Dec 12, 2007, 10:51 PM (the word you're looking for is inshu'allah.;)) Yes, the help file is going to be a .chm file made using a microsoft program.
alerum68 Apr 30, 2008, 06:04 PM 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:
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.)
It's already formated into the most common format for help files, so don't change any formating please. This includes file names.
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.
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!
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.:)
alerum68 May 01, 2008, 08:44 PM I'm trying to convert the Configuration PDF into HTML, but I'm lossing images. i've also tried converting to DOC then to HTML, but the images won't export to that either. Any suggestions, besides recoding it?
alerum68 May 01, 2008, 09:30 PM I got the file to convert, but it lost some formating, and the images aren't in quiet the right spot. Anyone want to do the finishing touches on this?;)
alerum68 May 01, 2008, 10:41 PM Okay, the Help file for both BUG and BAT are now set up for translations. Just translate the HTML contained within the Language directory for your mother tongue. Don't worry about the .wcp file, as that's just a template for when I build it.
I also did some clean up on the docs within the SVN, and the help file is now located in the Extra Stuff directory as well.
Cammagno May 01, 2008, 11:32 PM I'm trying to convert the Configuration PDF into HTML, but I'm lossing images. i've also tried converting to DOC then to HTML, but the images won't export to that either. Any suggestions, besides recoding it?
Do you want the doc version instead of the pdf one?
alerum68 May 01, 2008, 11:48 PM I've actually got it converted to HTML now, but needs to be formated to conform to the rest of the documents.
alerum68 May 01, 2008, 11:48 PM double post. sorry
alerum68 May 03, 2008, 02:50 PM Just did an update of my local copy of the SVN. You guys are kicking some arse in the translations! How come this board is based in the US, but there is not one spanish speaking user of our Mod who wants to translate?:p
EmperorFool May 03, 2008, 03:39 PM I suspect the native Spanish speakers that live in the U.S. are not likely to play Civ. We're gonna need someone from Spain or Venezuela to do the translations.
The Doc Jun 10, 2008, 11:40 AM Just commited the full German translation of all help files to SVN. Finally. :D
alerum68 Jun 10, 2008, 01:19 PM Wow! Awesome job Doc! Now we just need Falc to take a break from FFHBUG and do the French, and we'll be 75% done with that project.
BTW - You guys are going to hate my guts with a passion when you see what I'm working on, and how much fun you'll have translating it.:p
ricardojahns Jun 14, 2008, 06:09 PM I am a long time veteran of the civ series, right from the hat, that magic little hat of 1991.
To the point: I'm a spanish native speaker who lives in Vancouver. Given my admiration for your work, I am willing to cooperate with your project and the translations.
Just please be patient with my timing. Being an immigrant is not easy lately.
Tell me what to do.
Regards,
Ricardo
ricardo.jahns@gmail.com
alerum68 Jun 14, 2008, 10:56 PM wow.... You have no idea how long I've waited to see this!;) First, I need to know your experience level. Have you ever used SVN or CVS? Second, do you have any xml experience?
If you already know how to use SVN then https://civ4bug.svn.sourceforge.net/svnroot/civ4bug is the URL you want to use. The Help file is located in the Extra Stuff folder, and already has a spanish directory set up for translations. It's based on HTML. Please leave the formating the same. The in-game text are located under BUG Mod, in the XML directory. There are quiet a few of them.
If you need help setting up SVN, or would like some help with the XML, then just let me, or one of the other translators know, and we'll walk you through it. It's rather simple, once you get the hang of the tags.
ricardojahns Jun 15, 2008, 11:08 AM No and no.
XML shouldn't be a problem, as long as I don't change any of the code, I should be able to work with it even in Notepad.
I have no idea what SVN is.
So, guide me. I dominate spanish and am very good at english, so the translations won't be a problem (except for "smilies", I have no idea how that word translates to spanish :lol::lol::lol:)
ricardojahns Jun 15, 2008, 11:10 AM Footnote:
Bay Area... wow! I still remember my love at first sight when I was there in 1998... if I weren't here, I would be there, for sure. Where exactly are you around the Bay?
I lived in Milpitas for two weeks in April of 1998. Wonderful!
alerum68 Jun 15, 2008, 12:01 PM I'm living in Concord, but am about to move to Antioch. It's in the East-East Bay. A few of us on the project are from the Bay Area actually.;) And yes, I've travelled alot, and it's probably one of the most beautiful places I've seen. No where else in the world can you go from Ocean, to Rain Forest, to Plains, to Snow, to Desert all in one day. I like Milpitas... I also took a job there when I was younger, but instead took a much higher pay one in Santa Rosa... anyway, enough of me.
XML: Yes, as long as you change just the text, and nothing instead of < >, you will have no problems. The one thing that maybe trick will be things dealing with the Pedia, but I'd leave that for now. I would strongly suggest getting another editor for the xml. Two good freeware editors are Notepad ++, and Cooktop. I prefer Notepad ++, as you won't have to learn how to use the interface like Cooktop. You can get it at SourceForge, or Download.com
SVN: (copied from the Latest Version thread.)
Project Development Page:
http://sourceforge.net/projects/civ4bug/
If you'd like to keep updated with the latest changes to the Mods, then use our SVN server. To do this, follow these directions:
1. Create an account on SourceForge. It's free, and there are alot of great projects on there besides ours.
2. Download the latest version of TortoiseSVN from here: Download TortoiseSVN Here
3. After installation, reboot system.
4. Create Directory to place the Mod. I'd suggest a directoy called "The BUG Project".
5. Explorer the directory you just created, and right click on it. Go to the Option that says "SVN Checkout."
6. Use one of the SVN URL's listed below, when prompted. Right click on the URL and select "Copy Link Location," and copy into Tortoise.
7. Enter Username and Password you created on SourceForge.
8. Once the directory has been downloaded, you can keep up to date by using SVN Update on the directory again.
9. To install you just have to use the Export command from within the TortoiseSVN context menu from inside Explorer.
10. To get the latest revision, right click on directory, and pick "SVN Update."
Source Forge SVN Links:
The Complete Project:
https://civ4bug.svn.sourceforge.net/svnroot/civ4bug
The BUG Mod:
https://civ4bug.svn.sourceforge.net/...4bug/BUG%20Mod
The BAT Mod:
https://civ4bug.svn.sourceforge.net/...4bug/BAT%20Mod
It can be a bit tricky to figure out at first, so let me know if you have any questions. Everything will be accessed from your windows Explorer. Once you have some pages translated, let me know and I'll give you commit access, and go over that with you. It sounds like a lot, but once you do it a few times, it'll be a breeze.
BTW - Which spanish speaking country are you native too?
alerum68 Jul 02, 2008, 06:41 PM I'm going to commit some changes to the help files tonight. The new Military Advisor one will be coming soon, hopefully, and I don't expect that to be very long, but the PLE one does have a little bit of weight to it. I'll put the new files into the respective language directory. The files that have changed will need to be compared and manual done, but the changes are very minor and should be able to be done within an hour. I don't expect any more translations to be done on BUG, but I will request for translations to be done on the BAT files. I know you don't use it Cam, but I'd really appreciate having them done. They are only files related to BAT in there, so you won't be having to do duplicate work. Thank you guys! With your help we've made this the most international mod out there, in all respects!:)
EmperorFool Jul 02, 2008, 09:37 PM Agreed. You guys are amazing in keeping up with the pace. :goodjob:
Cammagno Jul 02, 2008, 11:49 PM I'm going to commit some changes to the help files tonight. The new Military Advisor one will be coming soon, hopefully, and I don't expect that to be very long, but the PLE one does have a little bit of weight to it. I'll put the new files into the respective language directory. The files that have changed will need to be compared and manual done, but the changes are very minor and should be able to be done within an hour.
:goodjob:
Other things to add are the GGBar.html file (for Great General Bar) and the update of Sevopedia.html to include also the Shortcuts and the Strategic Guides sections (you may also remove the version history from that file, as you have done from all the other ones (I already did in the Italian version)).
I don't expect any more translations to be done on BUG, but I will request for translations to be done on the BAT files. I know you don't use it Cam, but I'd really appreciate having them done. They are only files related to BAT in there, so you won't be having to do duplicate work.
I'll do it for sure, but almost for sure not for this release... I have problems even to complete the translation of all the BUG help files in time for the 6, but I hope the weekend will help me.
Cammagno Jul 02, 2008, 11:51 PM ---deleted---
alerum68 Jul 03, 2008, 12:12 AM I added the bit about the shortcuts and strategy guides in things we changed, but not Sevopedia. Will have to remember to add the GGPBar. Thanks for working on BAT.:)
Cammagno Jul 03, 2008, 12:34 AM I added the bit about the shortcuts and strategy guides in things we changed, but not Sevopedia.
I've seen it, this is the reason for that deleted message ;)
One more thing. :blush:
I really think that we should delete the Improved Unit Icons help file, and keep only the PLE one. No reason to have an help file for a mod that, in fact, doesn't exist anymore in BUG; it make things confused without adding any benefit.
ruff_hi Jul 03, 2008, 08:56 AM added some documentation about the Military Adviser in the MA thread (http://forums.civfanatics.com/showpost.php?p=6993320&postcount=188).
alerum68 Jul 03, 2008, 03:31 PM I deleted the IUI.html file for Eng, Fra, and Spa, but didn't want to delete it from Deu or Ita just because I didn't want to delete your translations.
Cammagno Jul 03, 2008, 03:55 PM I deleted the IUI.html file for Eng, Fra, and Spa, but didn't want to delete it from Deu or Ita just because I didn't want to delete your translations.
Ah, ok, good idea :)
(In Ita it wasn't translated yet, but I think in Deu it was).
alerum68 Jul 04, 2008, 11:09 PM Camm, can you translate the title of "What is the BUG Mod?" please?
Also, I finished the MA help file, and also removed RCP.HTML and replaced it with a new file called Raw Yields. I kept both of them short. I also made a few other changes in the help file. I think I caught everything for the update.
alerum68 Jul 04, 2008, 11:50 PM BTW - I know we won't be able to get it out before the release, but would either of you be willing to translate the website?
Cammagno Jul 05, 2008, 12:20 AM Camm, can you translate the title of "What is the BUG Mod?" please?
Done :)
Also, I finished the MA help file, and also removed RCP.HTML and replaced it with a new file called Raw Yields..
Not yet in the repo, though? :confused:
And IUI is still there for all languages (not for ITA because I've deleted it)
I also made a few other changes in the help file I think I caught everything for the update.
Ok, good. Things that we have to remember to add:
- Great General Bar help file
- mention of Shortcuts and Strategy Guides in Sevopedia help file
Furthermore, if we include some more mod (like Asphalt one and those map scripts) we need to modify the IncludedMod file to mention them and to create new help files for them (with instruction on how to uninstall them).
Cammagno Jul 05, 2008, 01:02 AM Not yet in the repo, though? :confused:).
Now it is there. :)
And IUI is still there for all languages (not for ITA because I've deleted it)
Still there
Ok, good. Things that we have to remember to add:
- Great General Bar help file
Now it is there. :)
But with some problems in title, author and credits (copy&past mistake, I suppose)
- mention of Shortcuts and Strategy Guides in Sevopedia help file).
Not yet done (I suggest also to remove version information)
Furthermore, if we include some more mod (like Asphalt one and those map scripts) we need to modify the IncludedMod file to mention them and to create new help files for them (with instruction on how to uninstall them.
alerum68 Jul 05, 2008, 01:06 AM Re - Shortcuts & Strategy Guides I am only going to put in the Things we changed area. Still working on things, and didn't think you'd be around yet.:p Give me a bit, and I'll make some changes.
Cammagno Jul 05, 2008, 01:08 AM Now it is there. :)
Now it is there. :)
But with some problems in title, author and credits (copy&past mistake, I suppose)
Partially corrected (not the wrong link for forum reference)
Cammagno Jul 05, 2008, 01:09 AM Re - Shortcuts & Strategy Guides I am only going to put in the Things we changed area. Still working on things, and didn't think you'd be around yet.:p Give me a bit, and I'll make some changes.
The same for me :blush:
Ok, for some time I'll only translate the included docs that I've not yet translated and I'll not touch any more the not-Italian files.
alerum68 Jul 05, 2008, 01:16 AM Okay, about to commit changes, but about Asphalt and map Scripts... haven't added the Map Scripts, and I thought we weren't going to add Asphalt because of it not being optional... will talk to EF about maybe removing it.
Cammagno Jul 05, 2008, 01:20 AM Okay, about to commit changes,
BTW, I suggest to give a look also at RowYields, translating it I've found a couple of obsolete lines from RCP
but about Asphalt and map Scripts... haven't added the Map Scripts, and I thought we weren't going to add Asphalt because of it not being optional... will talk to EF about maybe removing it.
Yeah!!! :D :D
alerum68 Jul 05, 2008, 01:26 AM Your right. Fixed.
Cammagno Jul 05, 2008, 02:08 AM Your right. Fixed.
Thanks :)
BTW, about Sevopedia, with "remove version information" I was speaking of that ugly list of version hystory at the end... we have removed from all the other readme, so I think we should do it even in this one.
Sorry for previous poor explanation :blush:
I could do that change myself, but knowing that you are also working on the help files...
Anyway, I think that at the end we'll have one of the best documentation available for a mod... :)
The Doc Jul 05, 2008, 07:32 AM I just commited the updated German documentation to SVN. I also removed IUI.html and RCP.html which are no longer used and deleted the version history in Sevopedia.html and NJAGC.html (hope, it's OK). :D
Edit: One thing I forgot: The PLE readme is really huge. Do we really need all that information? I know, you wrote at the Included Mods front page that one can read the "original" readmes in the help file. But PLE is heavily modified by EmperorFool and NikNaks and so the information in the PLE readme could be a bit shortened. :dunno:
NikNaks Jul 05, 2008, 08:32 AM Having read through the PLE help file, a lot of it is also wrong. I'm rewriting it now.
alerum68 Jul 05, 2008, 08:58 AM Please change all renamed file names back to the orginal names please. Titles don't matter, but for creating the actual help file it does. If I hadn't caught that everything you renamed would have been removed from the help file, and the original entries would be blank.
edit: Nevermind, changed back already. Please only alter the text.
The Doc Jul 05, 2008, 09:23 AM Please change all renamed file names back to the orginal names please. Titles don't matter, but for creating the actual help file it does. If I hadn't caught that everything you renamed would have been removed from the help file, and the original entries would be blank.
edit: Nevermind, changed back already. Please only alter the text.
What do you mean? I never touched the file names. :confused: Afair, Cammagno renamed some files but only for the Italian ones. :dunno:
Cammagno Jul 05, 2008, 09:44 AM What do you mean? I never touched the file names. :confused: Afair, Cammagno renamed some files but only for the Italian ones. :dunno:
I changed those names because they were wrong.
Specalist Stacker is missing a "I", so I made it SpecialistStacker
Unitrenaming is wrong because the name of the mod is UnitNaming (it doesn't REname anything), so I made it UnitNaming
and than I also removed the space to Raw Yields into RawYields for consistence, because all the other names were without spaces.
Of course till now I changed only the Italian ones, but if needed I can find the time to change also the other ones.
So I strongly suggest to change them also in the other languages and use the new ones (I don't see which can be the problem for the help creation, it should be like deleting or adding new files), and I don't see why in an important release like this one we should have some mistype. Furtermore, of course, I changed the names also in the corresponding links in the Included Mods file, and I don't like so much the idea of reverting them to the wrong spelling.
Edit: Anyway, if it really is a problem, ok, I'll revert the links to the wrong names... let me know... :)
alerum68 Jul 05, 2008, 09:47 AM Yes, but I have configured the help files to use those file names already. So when it tries "Source/ITA/Raw Yields.html", it won't and it will displayed "File not Found." in the help file. Capitalization won't affect it, but adding or removing spaces will. The file names really aren't important anymore. They could be 1, 2, 3, or a, b, c, as long as the help file can locate them. When we couldn't name a title, and each file name was how the user located the help, then it was crucial, but now it's more important that the help compiler can locate them.;)
alerum68 Jul 05, 2008, 09:49 AM The file names won't even be shown Camm. The only people who see the file names now are the people who are working on the docs. And it is a pain in the A$$ to do those help files, and after spending most of my holiday off yesterday, I don't want to go back and change them. Like I said, the filename won't be displayed so it doesn't matter.
Cammagno Jul 05, 2008, 09:53 AM Yes, but I have configured the help files to use those file names already. So when it tries "Source/ITA/Raw Yields.html", it won't and it will displayed "File not Found." in the help file. Capitalization won't affect it, but adding or removing spaces will. The file names really aren't important anymore. They could be 1, 2, 3, or a, b, c, as long as the help file can locate them.
Yes, but I don't like to have wrong names in the links... :blush:
When we couldn't name a title, and each file name was how the user located the help, then it was crucial, but now it's more important that the help compiler can locate them.;)
Ok, but the help compiler can be changed, I think, as you do for removed and new files... and considering that I'll need till tomorrow afternoon to complete the translation... maybe you can... ok, ok no :D
I'll revert also the link in Included Mods file to point to the WRONG names... :cry:
Cammagno Jul 05, 2008, 09:56 AM The file names won't even be shown Camm. The only people who see the file names now are the people who are working on the docs. And it is a pain in the A$$ to do those help files, and after spending most of my holiday off yesterday, I don't want to go back and change them. Like I said, the filename won't be displayed so it doesn't matter.
Ok, ok :)
But anyway you can't do help files now, I've to complete the translation (still PLE missing (waiting for the new version of Niknaks) and ALL the Option pages), and it requires me at least all tomorrow morning... I'm working as hard as possible to finish before the deadline :blush:
alerum68 Jul 05, 2008, 10:00 AM I already took care of the links Camm. I wont' have time today to work on this anymore today, and tomorrow I will be busy packaging this up. It is why I spent the Fourth of July working on it. Take your time with the translations... I know how hard it is trying to translate something so it doesn't just work, but sounds right.
EmperorFool Jul 05, 2008, 05:49 PM The Raw Yields XML (labels and hovers) are ready for translation guys. Note that the hover for the "All Tiles" button cannot be seen in the game since I haven't decided whether or not to add the button yet. Please just translate it so if I add it, it's already done.
Thanks!
alerum68 Jul 05, 2008, 08:55 PM Cam, wasn't sure if you knew this or not, but there are 8 pages in the ITA folder that haven't been translated. They are under the Options folder, and tell what each tab in the option screen does.
NN wasn't able to translate the PLE file, so what would you guys like to do about that? Google it for now?
alerum68 Jul 05, 2008, 11:42 PM Okay I did some work on the website, which I haven't updated quiet yet, as well as updating some Docs. The Comamnds.html and Included Mods.html files need to be edited slightly. I also added a very short doc for I love Asphalt, telling the user how to disable in the docs as well. I did not add anything for the MapScripts, as I'm thinking most of them will be in the new patch, as well as future patches, so it was more to bring 3.13 up to date.
Ruff has also changed the way the help file will be pulled up. Instead of having one help file, with "books" for each language, we will now have 5 different help files. There will be one for each language, and the Help button and shortcut command will both pull up the translated help file depending on the langauge selected.:):):)
Cammagno Jul 05, 2008, 11:52 PM Cam, wasn't sure if you knew this or not, but there are 8 pages in the ITA folder that haven't been translated. They are under the Options folder, and tell what each tab in the option screen does.
I know, and you also should :p
But anyway you can't do help files now, I've to complete the translation (still PLE missing (waiting for the new version of Niknaks) and ALL the Option pages), and it requires me at least all tomorrow morning... I'm working as hard as possible to finish before the deadline :blush:
With the new additions and changes to translate, I may need also some hours of the afternoon, but I'll try to finish before the morning.
NN wasn't able to translate the PLE file, so what would you guys like to do about that? Google it for now?
If I'm not wrong, NN wasn't supposed to translate the PLE file, was supposed to rewrite it fixing the errors and maybe reducing its lenght. If he has done it, I can translate it. If not, it will stay as it is or it can be removed for now (I havn't read it, but if it has errors as NN sayd, to remove it is my preference), but NEVER translated with Google or any other translator: I don't know about the other languages, but for Italian they are total crap.
alerum68 Jul 06, 2008, 12:09 AM Oh I knew, but was trying to remind you about it politely.;) Like I said, translators have until 2PM GMT. That should be around 4 of 5PM for you? And sorry for my typo... NN did not rewrite the PLE.HTML file. There are no errors in it, it just does not have the changes we have made, which are listed in both the Changes and in the PLE Options tab. All the information, is valid, besides any refrences for it being for Warlords, which shouldn't matter if you want to search them out and delete them. But I agree it is to long to translate as is. I know the translations for Google will be crap, but if you are okay with having an english page in your translation, then I will be too. I don't agree with removing it though.
Cammagno Jul 06, 2008, 12:38 AM Oh I knew, but was trying to remind you about it politely.;)
I know, i know, I get up at 6 o'clock :D (which is a couple of hours ago)
Like I said, translators have until 2PM GMT. That should be around 4 of 5PM for you?
Just to be sure... which time is it now in this GMT? :)
And sorry for my typo... NN did not rewrite the PLE.HTML file. There are no errors in it, it just does not have the changes we have made, which are listed in both the Changes and in the PLE Options tab. All the information, is valid, besides any refrences for it being for Warlords, which shouldn't matter if you want to search them out and delete them. But I agree it is to long to translate as is. I know the translations for Google will be crap, but if you are okay with having an english page in your translation, then I will be too. I don't agree with removing it though.
If there are no real errors, no reason to delete it. :)
Is long, so I'll leave it for last, and if I don't manage to translate it we can leave it in English. Yes, I prefer to leave it in english because if it is in english everybody can easily understand that it has not yet been translated, while if it is in bad Italian somebody can think that the Italian translator is a bad one :p :lol:
Cammagno Jul 06, 2008, 12:43 AM Is long, so I'll leave it for last, and if I don't manage to translate it we can leave it in English.
Anyway, if I'm not wrong, we wanted to beta-test this release... so maybe we can use that week (or what it is the time for beta-testing) to check also the help files, and after it maybe do a new release with an updated help file, including translation not included (if there will be some) and some fixes (I've found some little errors in English files while translating, but I'm to in a hurry for the deadline to take note of them or correct them in the english files).
Or in any case we'll do this work for a future release.
alerum68 Jul 06, 2008, 12:44 AM Good point about thinking you did a bad job as a reason not to do it.;) NN posted that he was going to work on it, so inshuallah he'll get it done just in time for you to finish the Options.;)
I think The Doc has all but the changes made today, and the new Asphalt and PLE docs done. 2PM should be perfect.
GMT = Greenwich Mean Time. It's UK time.
NikNaks Jul 06, 2008, 12:47 AM And it's 7:47 GMT if you were wondering. I'm uploading a corrected (but still lengthy) PLE help doc. If it still needs to be shortened, I'll see if there's any information that can be abridged.
EDIT: Just so you know, there were many, many errors in it ;)
Cammagno Jul 06, 2008, 02:15 AM I've found some little errors in English files while translating, but I'm to in a hurry for the deadline to take note of them or correct them in the english files.
I'll report here the relevant ones that I find while translating option pages.
Scoreboard: - worst enemy option missing
Edit:
other errors moved to my other post
alerum68 Jul 06, 2008, 02:25 AM Cool. I'll go ahead and change anything you list and make sure to update the FRA and SPA directories as well.
alerum68 Jul 06, 2008, 02:48 AM I see what is confusing you about the install file. That part that has Mods\BUG is outdated. The installer will now put it in the Mod directory for you if you choose that option.
WARNING: The BUG Project may overwrite some or all of the files in your current "CustomAssets" folder. It is recommended to back up this folder if you have other items you wish to preserve, not related to BUG.
That is all it should contain now. The WARNING should remain Red.
Cammagno Jul 06, 2008, 05:20 AM New post with all the 'errors' found in Option pages till now
Scoreboard: worst enemy option missing
Advisors: tech wide screen option missing
Advisors: military advisor option missing
Reminders: couple of options missing (view mode and record with autolog)
General: the Promotion Available option should be deleted
General: specialists option missing
PLE: some info given here are obsolete
Cammagno Jul 06, 2008, 07:01 AM Edit:
I've uploaded all the Option pages, so for me it's "GO!"
Only thing untranslated is PLE readme, I'll do it later.
The Doc Jul 06, 2008, 07:18 AM With about 10 more minutes I can fcomplete the option pages.
You don't have to hurry. Translators have another week or so. Code freeze is only for Coders. :D
Cammagno Jul 06, 2008, 07:21 AM You don't have to hurry. Translators have another week or so. Code freeze is only for Coders. :D
Yeah, but I think that Alerum will pack the help files today, so the more translated pages are there, the better it is :)
Anyway, for today is enough, PLE will wait... if I translate only one more page, I'll get sick :D
Oh, and I have to give you all my respect, you are very quick! :goodjob:
The Doc Jul 06, 2008, 07:34 AM Yeah, but I think that Alerum will pack the help files today, so the more translated pages are there, the better it is :)
Anyway, for today is enough, PLE will wait... if I translate only one more page, I'll get sick :D
Oh, and I have to give you all my respect, you are very quick! :goodjob:
Actually, I'm pretty lazy at times. :D And you are pretty fast, too. Don't hide your light under a bushel. :goodjob:
alerum68 Jul 06, 2008, 09:47 AM That's partially true in regards to the help file... any xml changes are done now though.
Cammagno Jul 27, 2008, 03:21 AM @ Alerum
I've started to translate the help files for BAT :)
So, I have a couple of question for you: :blush:
1) Which version of Varietas Delectat is included in BAT?
2) The Ethnic Artsyles mod that we include in BAT is the same that is already included in VD?
2b) I read that from v.4 of VD Ethnic Artsyles has been dropped and Ethnic Citystyles has been included in VD, is/will-be the same in BAT?
3) The Cultural Diversity mod that we include in BAT is the same that is already included in VD?
TIA for the answers :)
alerum68 Jul 27, 2008, 12:24 PM 1) We're using 3.6 currently.
2) Yes, Ethnic Artstyle is included in VD, and the same as in BAT.
2b) We have not gone to version 4.0 yet, but IIRC there was some partial Citystyles in this BAT. I would hold off on this document fornow.
3) CD is not in BAT 1.0, as it contained BUG 2.2x in it, and I didn't see enough of a change from VD to include it, assuming he would upgrade his mod with BUG 3.0 eventually.
Also, I should say that I'm going to be very busy in the coming weeks, and probably won't online. I will also be unreachable from August 7th until August 20th for vacation.
Cammagno Aug 19, 2008, 07:49 AM We need some documentation stuff about Enhanced Victory Screen and about PublicMaps included in BUG.
ruff_hi Aug 19, 2008, 07:51 AM We need some documentation stuff about Enhanced Victory Screen and about PublicMaps included in BUG.What is the best way of documenting this? Word / Thread / other?
Cammagno Aug 19, 2008, 08:02 AM What is the best way of documenting this? Word / Thread / other?
No problem, use the way that you prefer, and then I'll convert your text in an html file (which later will be included into the chm) following the pattern used for other help files... txt, doc, post on CVC, I really don't care, it's a copy&past work anyway :)
Cammagno Aug 20, 2008, 01:38 AM @The Doc
The files inside Extra Stuff\Old DEU Docs folder are still useful or can be deleted?
The Doc Aug 21, 2008, 11:51 AM @The Doc
The files inside Extra Stuff\Old DEU Docs folder are still useful or can be deleted?
Can be deleted. I haven't used them anyway.
|
|