Update of /cvsroot/netrek/client/netrekxp/resources/docs
In directory sc8-pr-cvs16:/tmp/cvs-serv5270/resources/docs

Modified Files:
	changes.txt netrekrc netrekxp.doc 
Log Message:
This patch gets the in game save feature almost where it needs to
be to allow the user to change all options in game and not have to
edit the netrekrc.  Other benefits are that placement of options in
netrekrcs are consistent, duplicate entries are weeded out, and
netrekrcs used from 1 client version to the next are standardized
by the in game save function and brought up to date with the latest
features.
The default saveFile is now netrekrc (it was netrekrc.sav before)
Fixed typo in printout of the path to the netrekrc during the save
process.
Added geometryDefault() function that acts like a stringDefault
but for geometries.  If the string is "auto" it ignores it.
In game save function now always saves window geometries,
currently it saves any auto or non-entry as "auto".  Future
enhancement would be to save values that changed from
initial values.
Removed some outdated beeplite features from the manual.
Removed two beeplite cycle_time variables as being netrekrc
options, as they were useless and had to be normalized to
server update rate anyways to work right.
The netrekrc save feature now saves ship specific
keymaps/ckeymaps/buttonmaps/netrekrc, and observer/servertype
specific options.  Saving servernick options is not supported, but I
doubt anyone uses those to begin with.
The ' key (single quote) is now the default key for toggling on and
off the expanded playerlist window

Index: netrekrc
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/netrekrc,v
retrieving revision 1.56
retrieving revision 1.57
diff -u -d -r1.56 -r1.57
--- netrekrc	7 Apr 2007 09:16:14 -0000	1.56
+++ netrekrc	9 Apr 2007 11:07:17 -0000	1.57
@@ -10,7 +10,7 @@
 # 'q', you would put 'qs' in your keymap.  Shields would still be mapped to
 # 's' as well as now being on 'q'.  Adding a mapping doesn't delete the old
 # one.  If you want shields on 'w' as well, put 'ws' in your keymap.  If you
-# had instead put 'wq', it would have mapped quit, the default action of 'q',
+# had instead put 'wq', it would have mapped quit (the default action of 'q')
 # onto 'w'.
 keymap: PpW Zva%d_eyftg^jmnrpPrls3tfuwvDwsye d
 
@@ -146,7 +146,7 @@
 # Log all messages to file. Requires "logfile" option
 logging: off
 
-# Make main window resizeable
+# Make main window + local/map windows resizeable
 mainResizeable: on
 
 # Start main window with title bar on (can be toggled by alt+enter)
@@ -546,6 +546,9 @@
 # Sound directory
 sounddir: .\sounds
 
+# Save file (for using in-game save feature)
+saveFile: netrekrc
+
 # Metacache file
 metaCache: metacache
 
@@ -583,11 +586,11 @@
 
 # Window placements section
 # Local and map windows MUST be square.  Size can be adjusted.
-# If sizing downwards, don't forget to remap any windows nested
-# inside these windows, such as team select and quit windows.
 # Most windows will autoadjust to the right spot if local or
-# map size are changed, so most window placements are commented
-# out.  Uncomment them if you wish to customize.
+# map size are changed, so most window placements are autoset
+# If you wish to customize, window geometry should be of the form
+# 502x885+1+1, 502x885, or +1+1.  The +1+1 indicates (x,y) point of
+# top left corner of window, the 502x885 indicates width x height.
 
 netrek.parent:          netrek
 netrek.geometry:        1024x768
@@ -599,104 +602,105 @@
 map.geometry:           500x500
 
 tstat.parent:           netrek
-#tstat.geometry:         504x42+0+506
+tstat.geometry:         auto
 
 message.parent:         netrek
-#message.geometry:       504x20+506+506
+message.geometry:       auto
 message.mapped:         on
 
 warn.parent:            netrek
-#warn.geometry:          504x20+506+526
+warn.geometry:          auto
 
 planet.parent:          netrek
-#planet.geometry:        57x43+516+10
+planet.geometry:        auto
 planet.mapped:          off
 
 rank.parent:            netrek
-#rank.geometry:          80x18+10+300
+rank.geometry:          auto
 rank.mapped:            off
 
 player.parent:          netrek
-#player.geometry:        +0+550
+player.geometry:        auto
 player.mapped:          on
 
 player2.parent:         netrek
-#player2.geometry:       +140+100
+player2.geometry:       auto
 player2.mapped:         off
 
 help.parent:            netrek
+help.geometry:          auto
 help.mapped:            off
 
 review_all.parent:      netrek
-#review_all.geometry:    81x5+506+660
+review_all.geometry:    auto
 review_all.mapped:      on
 
 review_team.parent:     netrek
-#review_team.geometry:   81x6+506+590
+review_team.geometry:   auto
 review_team.mapped:     on
 
 review_your.parent:     netrek
-#review_your.geometry:   81x3+506+550
+review_your.geometry:   auto
 review_your.mapped:     on
 
 review_kill.parent:     netrek
-#review_kill.geometry:   81x3+506+720
+review_kill.geometry:   auto
 review_kill.mapped:     on
 review_kill.allow:      KP
 
 review_phaser.parent:   netrek
-#review_phaser.geometry: 81x4+506+750
+review_phaser.geometry: auto
 review_phaser.mapped:   off
 
 review.parent:          netrek
-#review.geometry:        81x20+506+550
+review.geometry:        auto
 review.mapped:          off
 
 pingStats.parent:       netrek
-#pingStats.geometry:     +500+4
+pingStats.geometry:     auto
 pingStats.mapped:       off
 
 UDP.parent:             netrek
-#UDP.geometry:           +510+9
+UDP.geometry:           auto
 UDP.mapped:             off
 
 network.parent:         netrek
-#network.geometry:       +510+9
+network.geometry:       auto
 network.mapped:         off
 
 DocWin.parent:          netrek
-#DocWin.geometry:        500x500+0+181
+DocWin.geometry:        auto
 DocWin.mapped:          off
 
 xtrekrcWin.parent:      netrek
-#xtrekrcWin.geometry:    500x500+0+200
+xtrekrcWin.geometry:    auto
 xtrekrcWin.mapped:      off
 
 fed.parent:             local
-#fed.geometry:           100x100+0+400
+fed.geometry:           auto
 
 kli.parent:             local
-#kli.geometry:           100x100+200+400
+kli.geometry:           auto
 
 ori.parent:             local
-#ori.geometry:           100x100+300+400
+ori.geometry:           auto
 
 rom.parent:             local
-#rom.geometry:           100x100+100+400
+rom.geometry:           auto
 
 quit.parent:            local
-#quit.geometry:          100x100+400+400
+quit.geometry:          auto
 
 stats.parent:           netrek
-#stats.geometry:         100x80+406+506
+stats.geometry:         auto
 stats.mapped:           off
 
 war.parent:             netrek
-#war.geometry:           20x6+510+9
+war.geometry:           auto
 war.mapped:             off
 
 sound.parent:           netrek
-#sound.geometry:         +520+9
+sound.geometry:         auto
 sound.mapped:           off
 
 
@@ -1078,3 +1082,7 @@
 msg.destroy: %N->%Z %N destroyed by %i (%T%c)
 msg.take: %N->%O %N taken by %i (%T%c)
 msg.ghostbust: GOD->ALL %i (%S) (%T%c) was kill %k for the GhostBusters
+
+# Esoteric features such as individual ship rcfiles/keymaps
+# /ckeymaps/buttonmaps, and observer/servernick/servertype
+# options (i.e. keymap.bronco: <keymap>)
\ No newline at end of file

Index: netrekxp.doc
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/netrekxp.doc,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -d -r1.14 -r1.15
--- netrekxp.doc	19 Mar 2007 19:59:43 -0000	1.14
+++ netrekxp.doc	9 Apr 2007 11:07:18 -0000	1.15
@@ -1112,11 +1112,6 @@
  
      Additional defaults:
 
-planetCycleTime:        highlighting time for planets
-playerCycleTime:        highlighting time for players
-
-tts_color:              color of TTS message (should be dark)
-tts_font:               Font (large prefered)
 tts_max_len:            Max length of a message
 tts_time:               Time a TTS message is displayed
 tts_ypos:               y location of the TTS message

Index: changes.txt
===================================================================
RCS file: /cvsroot/netrek/client/netrekxp/resources/docs/changes.txt,v
retrieving revision 1.163
retrieving revision 1.164
diff -u -d -r1.163 -r1.164
--- changes.txt	9 Apr 2007 07:46:12 -0000	1.163
+++ changes.txt	9 Apr 2007 11:07:17 -0000	1.164
@@ -1,4 +1,17 @@
 Netrek XP 2006, Version 1.3:
+- working on getting window placements and sizes to save with the in-game save key,
+  For the most part you the user will never need to manually edit the netrekrc again,
+  well maybe for changing login name or making macros.
+- new netrekrc option "saveFile: name" to control what filename you write to when you
+  save your options in game (either with " key or via the save menu).  Default is now
+  netrekrc, so that means if you save in-game, it will overwrite your netrekrc with
+  your current settings (I have a feeling the benefits of this strongly outweigh the
+  negatives such as mistakenly remapping things then mistakenly saving your netrekrc)
+- the netrekrc save feature now saves ship specific keymaps/ckeymaps/buttonmaps/netrekrc,
+  and observer/servertype specific options.  Saving servernick options is not supported,
+  but I doubt anyone uses those to begin with.
+- the ' key (single quote) is now the default key for toggling on and off the expanded
+  playerlist window
 - now get a popup box when client receives a game shutdown message from server, indicating
   that the game has been terminated and to try again later
 - the mainResizeable netrekrc option now allows map/local to be resizeable via dragging