Changeset df26b81 in git


Ignore:
Timestamp:
21/01/14 04:15:24 (6 years ago)
Author:
Olly Betts <olly@…>
Branches:
line_contents, master, stereo, travis-osx
Children:
099256a
Parents:
53496ab3
Message:

doc/TODO.htm: Remove things which have now been done, and reorganise
the rest.

Files:
2 edited

Legend:

Unmodified
Added
Removed

  • ChangeLog

    r53496ab3 rdf26b81  
     1Tue Jan 21 04:14:55 GMT 2014  Olly Betts <olly@survex.com>
     2
     3        * doc/TODO.htm: Remove things which have now been done, and reorganise
     4          the rest.
     5
    16Tue Jan 21 03:48:07 GMT 2014  Olly Betts <olly@survex.com>
    27

  • doc/TODO.htm

    r53496ab3 rdf26b81  
    88<H1>Survex To-Do List</H1>
    99
    10 <ul>
    11 
    12 <li>Update translations.
     10<H2>3d format</H2>
     11
     12<ul>
     13
     14<li>sort out XSECT - I'm sure I meant there to be 1 and 2 byte forms, not 2
     15and 4 - 4 byte is only useful if a passage dimension is &gt; 327.67m!
     16
     17<li>store equated stations in some way
     18
     19<li>store legs by end stations rather than repeating coordinates over and
     20over?
     21
     22</ul>
     23
     24<H2>Aven</H2>
     25
     26<ul>
     27
     28<li>loading a .3d file with no survey data (or which has a valid header but is broken later) with a survey already loaded doesn't work well.
    1329
    1430<li>After keyboard controlled movement, the measuring line/circle doesn't
    1531reappear until the mouse is moved (e.g. plan/elevation transition with P/L).
    1632
    17 <li>Save cavern log from aven?
    18 
    19 <li>Sort out display of full unicode in OpenGL window (currently we only
    20 handle latin1 there, which is sufficient for all the current i18ns).
    21 
    22 <li>img should return img_XSECT from Compass PLT files.
    23 
    2433<li>Fix depth clipping on grid
    2534
    26 <li>Consider using "legend" instead of "info box"...
    27 
    2835<li>Reword "Shift Survey Left", etc?
    29 
    30 <li>Look at rewording extend.sgml (AndyA comments)
    31 
    32 <li>message.c should perhaps use GetUserDefaultUILanguage() on WinMe/Windows2000 or
    33 later to find language id.  It's what MS say you should use, although some of
    34 the comments here suggest that perhaps it's not ideal (and wx still uses
    35 GetUserDefaultLCID() too):
    36 <a href="http://blogs.msdn.com/michkap/archive/2006/05/22/604509.aspx">http://blogs.msdn.com/michkap/archive/2006/05/22/604509.aspx</a>
    37 
    38 <li>Lots of aven things need documenting.
    3936
    4037<li>Does anyone use Controls-&gt;"Reverse Sense"?  It made some sense with
    … …  
    6259may be needed to get meaningful timing info.
    6360
    64 <li>3d format:
    65 <ul>
    66   <li>sort out XSECT - I'm sure I meant there to be 1 and 2 byte forms, not 2
    67   and 4 - 4 byte is only useful if a passage dimension is &gt; 327.67m!
    68 
    69   <li>store equated stations in some way
    70 
    71   <li>store legs by end stations rather than repeating coordinates over and
    72   over?
    73 </ul>
    74 
    7561<li>Add "colour by survey" - colour by cave (and more generally by sub-prefix):
    7662maybe "aven --survey 161 --colour-by-sub-prefix all.3d" would result in
    … …  
    7965<li>Implement "Skip blank pages" in aven printing
    8066
    81 <li>Terrain data (patch from PhilU)
    82 
    83 <li>*fix with datums etc
     67<li>Terrain data (patch from PhilU) "surface.png is for a textured landscape --
     68there needs to be a menu option to select the texturing on/off, and this should
     69be the texture used. map.png is just a different surface overlay for Loser."
    8470
    8571<li>different keyboard layouts mean that some key choices don't make much sense...
    86 
    87 <li>*data chamber ...
    88 
    89 <li>*data nsew ... for pitches (bearings rather than having to be NSEW)
    9072
    9173<li>Easy way to "print extended elevation"
    … …  
    9476threshold...
    9577
     78<li>Some way to view older/newer version of survey
     79
     80<li>Label lengths aren't considered when working out image size when
     81printing so a long label can spill off the edge of the printout
     82
     83<li>print to an image file?
     84
     85<li>grid on printouts
     86<ul>
     87<li>grid crosses option (only draw cross at intersections, not a full grid).
     88<li>[(x,y) of a point to go through (easting, northing)
     89<li>x spacing, y spacing (default to x spacing)
     90<li>orientation (bearing of y-axis?) (defaults to 0)]
     91</ul>
     92
     93<li>Profile aven further (for both speed and memory usage)
     94
     95<li>by default put crosses on those points with no legs attached (unused
     96fixed points)?
     97
     98<li>label junctions/dead ends?
     99
     100<li>section colouring/selective labelling
     101
     102<li>clipping - want to select a clip sphere (or maybe cube) centred on
     103centre on rotation I think.
     104
     105<li>Some way to display all the names of an equated station (e.g. in pop-up
     106window or the info panel).
     107
     108<li>check on monochrome, 16, and 256 colour displays - especially that depth
     109colouring looks OK
     110
     111<li>Feed back redraw time to key based movement as in caverot?  Or perhaps best
     112not to?  It depends on whether we expect people to hold down keys or not...
     113Perhaps something smart where the first press is a fixed size, then after that
     114it depends on the redraw?
     115
     116<li>Save cavern log from aven?
     117
     118<li>improve .plt export to include less crude survey structure.
     119
     120<li>If multiple methods for drawing crosses and/or blobs pass the
     121visual fidelity check, check which is fastest.
     122
     123<li>Lots of aven things need documenting.
     124
     125</ul>
     126
     127<H2>Documentation</H2>
     128
     129<ul>
     130
     131<li>Platform specific versions of docs?
     132
     133<li>Put more terms in terminology in docs ? trip, instrument, ...
     134
     135<li>Finish off manual loose ends.
     136
     137<li>Look at using docbook2man instead of docbook-to-man (command is
     138<i>nsgmls man_aven.sgml | sgmlspl /usr/lib/perl5/sgmlspl-specs/docbook2man-spec.pl</i>).  Issues are: double space between sentences is lost;
     139double blank lines appear in output.
     140
     141<li>Make sure there's documentation for all the various settings in print.ini
     142(colours aren't documented at present)
     143
     144<li>Document dump3d
     145
     146<li>Look at rewording extend.sgml (AndyA comments)
     147
     148</ul>
     149
     150<H2>Internationalisation and Localisation</H2>
     151
     152<ul>
     153
     154<li>Update translations.
     155
     156<li>control of output units in .err file and in stats at end of cavern run?
     157In fact anywhere we report a value in degrees or metres, the units should be
     158selectable
     159
     160</ul>
     161
     162<H2>Test Suite</H2>
     163
     164<ul>
     165
     166<li>test diving data with compass omitted (plumbed)
     167
     168<li>more tests for direction
     169
     170<li>improve 3d torture test and try to automate its use if possible.
     171
     172<li>Compass .mak and .plt and CMAP .xyz in test suite?
     173
     174<li>img.c: explicitly test routines in test suite?
     175
     176</ul>
     177
     178<H2>Miscellaneous</H2>
     179
     180<ul>
     181
     182<li>resolve FIXMEs in code
     183
     184<li>diffpos: compare connectivity (i.e legs as well as stations) - e.g.
     185
     186<pre>
     187foo.1 moved by (0.02, 0.10, -0.06)
     188leg between foo.1 and bar.2 removed
     189...
     190bar.2 moved by (-0.02, -0.05, 0.03)
     191</pre>
     192
     193</ul>
     194
     195<H2>Cavern</H2>
     196
     197<ul>
     198
     199<li>This gives "*** Singular!!!" warning with DEBUG_INVALID on:
     200<pre>
     2011 2 50000 0 -
     2021 2 5 0 -30
     203</pre>
     204
     205<li>Default variance for topofil counter? (currently same as that of tape)
     206
     207<li>Rather than forming a linked list of components, solve each as it is
     208identified?  Beware of issues like those that revcomplist test checks.
     209
     210<li>Don't split other traverses at articulating traverses when reporting error
     211stats.
     212
     213<li>sort out title which goes in .3d file for this (if no *includes in ...
     214it gets the title of the leafname of this .svx file, otherwise it's the
     215leafnames of the *include-d files, comma-separated):
     216
     217<pre>
     218*begin mycave
     219*title "My Cave"
     220...
     221*end mycave
     222</pre>
     223
     224<li>look at solution by QR factorisation in matrix.c more
     225
     226<li>consider disabling the more expensive asserts - turning them all off
     227speeds up cavern by about 10%.
     228
    96229<li>
    97230Warn bearings not 3 digits, gradient not &lt;sign&gt;&lt;digit&gt;&lt;digit&gt;
    98231
    99 <li>Allow angles as deg/min/sec (for theodolite data) (060&deg;10'15" as 060 10
    100 15, or 060.1005 (crap notation))
    101 
    102 <li>Add support for bearings of form N20E (ie [NS][0-9]+[EW])?
    103 
    104 <li>should % after a clino reading work?
    105 
    106232<li>cavern: auto declination?
    107233
    108234<li>Sort out gross error detection code
    109 
    110 <li>Fixing a point by triangulation?
    111 
    112 <li>Theodolite + level:
    113 <ul>
    114   <li>delta(bearing (relative to 0 at start)
    115   <li>delta(horizontal)
    116   <li>delta(vertical) / maybe "clino" instead
    117 </ul>
    118 
    119 <li>Theodolite only:
    120 <ul>
    121   <li>delta(bearing (relative to 0 at start)
    122   <li>delta(horizontal)
    123   <li>infinite sd for z
    124 </ul>
    125 
    126 <li>Infinite sds so we can fix in x and y only (or z only)?
    127 
    128 <li>use more accuracy than nearest point (1/72") in printps?
    129 
    130 <li>Some way to view older/newer version of survey
    131 
    132 <li>Label lengths aren't considered when working out image size when
    133 printing so a long label can spill off the edge of the printout
    134235
    135236<li>For warnings such as "Suspicious compass reading", report the reading
    … …  
    137238Also report values when warning about problems with processed readings.
    138239
    139 <li>legs: implied: inloop/plumb/nosurvey, diving, other styles
     240<li>legs: implied flags: inloop/plumb
    140241
    141242<li>legs: "dubious" for "tapeless" legs - bearing along continuation...
    142 
    143 <li>legs: hydrology - fossil/active/not recorded/static water/underwater
    144 (sump) [diving underwater by default? except style can mean altimeter
    145 too...]
    146 
    147 <li>legs: floor type - mud/sand/breakdown/flowstone/etc and can then used
    148 LRUD to draw crude survey...
    149 
    150 <li>legs: "commented out" flag?  syntax check data but otherwise ignore
    151243
    152244<li>station flags: "important" - e.g. top camp "fixed" point /
    … …  
    155247of its nodes is)
    156248
    157 <li>Allow valid range for an instrument to be specified.  Tie in with
    158 *instrument.  *units date - ranges for dates - e.g. "1990-" or
    159 "jun-aug"...
    160 
    161249<li>Maybe station lists should know how long they are?
    162 
    163 <li>cope with any combination of readings which gives enough info ???
    164250
    165251<li>Articulation point code: ideally the articulation point code should allow
    … …  
    167253points?
    168254
    169 <li>leg and station "comments":
    170 
    171 <pre>*data passage station left right up down comment
    172 
    173 1 1.0 - 50+ 0.5 "large cairn"
    174 
    175 2 ...
    176 
    177 *data normal station l r u d comment newline tape compass clino
    178 
    179 1 1.0 - 50+ 0.5 "large cairn"
    180 
    181   10.78 123 -03
    182 
    183 2 ...
    184 </pre>
    185 
    186 comment can be omitted "-" or not present if at end of line...?
    187 commentall?
    188 
    189 <li>GPS support (e.g. export survey as GPS coords)
    190 
    191 <li>print to an image file (use gd? or wxwidgets...)
    192 
    193 <li>Allow covariances to be specified in cartesian style?
    194 
    195 <li>grid on printouts
    196 <ul>
    197 <li>grid crosses option (only draw cross at intersections, not a full grid).
    198 <li>[(x,y) of a point to go through (easting, northing)
    199 <li>x spacing, y spacing (default to x spacing)
    200 <li>orientation (bearing of y-axis?) (defaults to 0)]
    201 </ul>
    202 
    203 <li>Mark: "surface.png is for a textured landscape -- there needs to be a
    204 menu option to select the texturing on/off, and this should be the
    205 texture used. map.png is just a different surface overlay for Loser."
    206 
    207 <li>Profile aven further (for both speed and memory usage)
    208 
    209 <li>by default put crosses on those points with no legs attached (unused
    210 fixed points)?
    211 
    212 <li>label junctions/dead ends?
    213 
    214 <li>section colouring/selective labelling
    215 
    216 <li>clipping - want to select a clip sphere (or maybe cube) centred on
    217 centre on rotation I think.
    218 
    219 <li>Some way to display all the names of an equated station (e.g. in pop-up
    220 window or the info panel).
    221 </ul>
    222 
    223 <H2>Miscellaneous Bugs</H2>
    224 
    225 <ul>
    226 
    227 <li>This gives "*** Singular!!!" warning with DEBUG_INVALID on:
    228 <pre>
    229 1 2 50000 0 -
    230 1 2 5 0 -30
    231 </pre>
    232 
    233 <li>aven: loading a .3d file with no survey data (or which has a valid header but is broken later) with a survey already loaded doesn't work well.
    234 
    235 <li>img.c: eliminate duplicate img_LABELs when reading .PLT files.
     255</ul>
     256
     257<H2>Survex file format</H2>
     258
     259<ul>
     260
     261<li>*fix with datums etc
     262
     263<li>*data chamber ...
     264
     265<li>*data nsew ... for pitches (bearings rather than having to be NSEW)
     266
     267<li>Allow angles as deg/min/sec (for theodolite data) (060&deg;10'15" as 060 10
     26815, or 060.1005 (crap notation))
     269
     270<li>Add support for bearings of form N20E (ie [NS][0-9]+[EW])?
     271
     272<li>should % after a clino reading work?
     273
     274<li>Fixing a point by triangulation?
    236275
    237276<li>multiple readings:
    … …  
    252291Implement as extension to number format so any suitable numeric value to be
    253292repeated?
    254 </ul>
    255 
    256 <H2>Aven</H2>
    257 
    258 <ul>
    259 
    260 <li>check on monochrome, 16, and 256 colour displays - especially that depth
    261 colouring looks OK
    262 
    263 <li>Feed back redraw time to key based movement as in caverot?  Or perhaps best
    264 not to?  It depends on whether we expect people to hold down keys or not...
    265 Perhaps something smart where the first press is a fixed size, then after that
    266 it depends on the redraw?
    267 </ul>
    268 
    269 <H2>Documentation</H2>
    270 
    271 <ul>
    272 
    273 <li>Platform specific versions of docs?
    274 
    275 <li>Put more terms in terminology in docs ? trip, instrument, ...
    276 
    277 <li>Finish off manual loose ends.
    278 
    279 <li>Look at using docbook2man instead of docbook-to-man (command is
    280 <i>nsgmls man_aven.sgml | sgmlspl /usr/lib/perl5/sgmlspl-specs/docbook2man-spec.pl</i>).  Issues are: double space between sentences is lost;
    281 double blank lines appear in output.
    282 
    283 <li>Make sure there's documentation for all the various settings in print.ini
    284 (colours aren't documented at present)
    285 
    286 <li>Document dump3d
    287 
    288 </ul>
    289 
    290 <H2>Survex file format</H2>
    291 
    292 <ul>
     293<li>Theodolite + level:
     294<ul>
     295  <li>delta(bearing (relative to 0 at start)
     296  <li>delta(horizontal)
     297  <li>delta(vertical) / maybe "clino" instead
     298</ul>
     299
     300<li>Theodolite only:
     301<ul>
     302  <li>delta(bearing (relative to 0 at start)
     303  <li>delta(horizontal)
     304  <li>infinite sd for z
     305</ul>
     306
     307<li>Infinite sds so we can fix in x and y only (or z only)?
     308
     309<li>legs: "commented out" flag?  syntax check data but otherwise ignore
     310
     311<li>legs: hydrology - fossil/active/not recorded/static water/underwater
     312(sump) [diving underwater by default? except style can mean altimeter
     313too...]
     314
     315<li>legs: floor type - mud/sand/breakdown/flowstone/etc and can then used
     316LRUD to draw crude survey...
     317
     318<li>Allow valid range for an instrument to be specified.  Tie in with
     319*instrument.  *units date - ranges for dates - e.g. "1990-" or
     320"jun-aug"...
     321
     322<li>cope with any combination of readings which gives enough info ???
     323
     324<li>leg and station "comments":
     325
     326<pre>*data passage station left right up down comment
     327
     3281 1.0 - 50+ 0.5 "large cairn"
     329
     3302 ...
     331
     332*data normal station l r u d comment newline tape compass clino
     333
     3341 1.0 - 50+ 0.5 "large cairn"
     335
     336  10.78 123 -03
     337
     3382 ...
     339</pre>
     340
     341comment can be omitted "-" or not present if at end of line...?
     342commentall?
     343
     344<li>Allow covariances to be specified in cartesian style?
    293345
    294346<li>flag legs as "skeletal" or something? (i.e. not in the cave passage) -
    … …  
    309361</ul>
    310362
    311 <H2>Internationalisation and Localisation</H2>
    312 
    313 <ul>
    314 
    315 <li>quotes in messages - translate too? e.g. `XXX' to &laquo; XXX &raquo;.  Eric
    316 suggests not in French.
    317 
    318 <li>control of output units in .err file and in stats at end of cavern run?
    319 In fact anywhere we report a value in degrees or metres, the units should be
    320 selectable
    321 
    322 </ul>
    323 
    324 <H2>Test Suite</H2>
    325 
    326 <ul>
    327 
    328 <li>test diving data with compass omitted (plumbed)
    329 
    330 <li>more tests for direction
    331 
    332 <li>improve 3d torture test and try to automate its use if possible.
    333 
    334 <li>Compass .mak and .plt and CMAP .xyz in test suite?
    335 
    336 <li>img.c: test routines in test suite?
    337 
    338 </ul>
    339 
    340 <H2>Miscellaneous</H2>
    341 
    342 <ul>
    343 
    344 <li>resolve FIXMEs in code
    345 
    346 <li>Default variance for topofil counter? (currently same as that of tape)
    347 
    348 <li>Rather than forming a linked list of components, solve each as it is
    349 identified?  Beware of issues like those that revcomplist test checks.
    350 
    351 <li>Don't split other traverses at articulating traverses when reporting error
    352 stats.
    353 
    354 <li>sort out title which goes in .3d file for this (if no *includes in ...
    355 it gets the title of the leafname of this .svx file, otherwise it's the
    356 leafnames of the *include-d files, comma-separated):
    357 
    358 <pre>
    359 *begin mycave
    360 *title "My Cave"
    361 ...
    362 *end mycave
    363 </pre>
     363<H2>img library</H2>
     364
     365<ul>
     366
     367<li>eliminate duplicate img_LABELs when reading .PLT files.
     368
     369<li>img should return img_XSECT from Compass PLT files.
    364370
    365371<li>make img more modular (convert to C++?)
    … …  
    368374releases of winkarst have broken .KST export/import...
    369375
    370 <li>resolve documentation/examples mismatch for station based .XYZ files and
     376<li>resolve documentation/examples mismatch for station based XYZ files and
    371377implement reading of legs from them.
    372378
    373 <li>diffpos: compare connectivity (i.e legs as well as stations) - e.g.
    374 
    375 <pre>
    376 foo.1 moved by (0.02, 0.10, -0.06)
    377 leg between foo.1 and bar.2 removed
    378 ...
    379 bar.2 moved by (-0.02, -0.05, 0.03)
    380 </pre>
    381 
    382 <li>improve .plt export to include less crude survey structure.
    383 
    384 <li>look at solution by QR factorisation in matrix.c more
    385 
    386 <li>consider disabling the more expensive asserts - turning them all off
    387 speeds up cavern by about 10%.
    388 
    389 <li>open aven, go full screen, Ctrl+O to open file, shows side panel while full
    390 screen which we don't normally do...
    391 
    392 <li>If multiple methods for drawing crosses and/or blobs pass the
    393 visual fidelity check, check which is fastest.
    394379</ul>
    395380
Note: See TracChangeset for help on using the changeset viewer.