This is the mail archive of the xconq7@sources.redhat.com mailing list for the Xconq project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: Updated files


Once I finish documenting things in Dosxygen, that's pretty much what we'll have, but with he addition of comments.  What I did was add some anchors to the texi documenation for the Game Description Language Refererence Manual so I could add a GDL Reference section to each function that will list the GDL elements used gby that function.  So, for exaple, in the do_disband_action function I can cross reference the properties acp_to_disband property, and allow he user to clink on that item and be taken to the part of the GDL reference manula that descrbes that property from the GDL Reference for that property.  eventually, I'd like to cross refernce all the other manuals that apply, but one step at a time.


 --- On Fri 12/13, Erik Jessen  wrote:From: Erik Jessen [mailto: ejessen@adelphia.net]To: Xconq7@sources.redhat.comDate: Fri, 13 Dec 2002 16:15:37 -0800Subject: Re: Updated filesI'm told there's a tool called 'c2html' that creates a website withcrossreferences to all variables, etc. etc. etc.Erik----- Original Message -----From: To: ; Sent: Friday, December 13, 2002 12:07 PMSubject: Updated files>> I have some file updates to make.  Should I send them to directly to Hans,or just attach tthem to an email for the group.  Also, I can send tar,gar.gz, or zip formatted files, or individual ascii files.  Which is thepreferred format?>> The biggest change is in refman.texi, where I'm adding anchors to crossreference the GDL and the runtines in the code.  I'm still working on a wayto document the .def files, which turns out to be moderatly important tounderstanding the code.  What I may have to do is create some special .hfiles int the doc directory, and rnun the C preprocessor on them, then do amerge with a documentation file if they change.  A bit of a pain, but so itgoes.>> Oh, and the texi file changes require upgrading to a newer version oftexi2html in order to process @html and @image tags in texi.  Thee is stilla bug in that I'm getting both the @ifinfo and @ifhtml parts of text I havein the texi files, but I think that will be fixed fairly soon.  Onedisagvantage of the newer texi2html program is that it visually splits thehtml file into sections, but doesn't physically split it into .html files.>>> But I feel that being able to crsoss reverence code and the manulas is auseful capability in the documenation, so I'm putting some work into beingable to do it.  Mostly adding invisible anchors for ever GDL @deffn section.I'd sue texi2html's anchors, but if you re-arrange, add, or remove sectionsor definitions, the tags change.  And you can't guess what they'll be aheadof time, whereas I'm using the convention of "GDL_ref_xxxx" where xxx is thename of the variable, form, table, ...  So for example acp_to_disband wouldhave the anchor "GDL_ref_acp-to-disband">> Oh, if anyone can convert jpg's to eps's, Id appreaciate them converting acouple of files for me to replace some to the "crude text" images for latexversions of the manuals>>>>>> _______________________________________________> Can a Web portal forever change your life?> Win up to $25 Million on iWon - click here!>

_______________________________________________
Can a Web portal forever change your life?
Win up to $25 Million on iWon - click here!


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]