color by...

[Olly Betts]

On Tue, Feb 18, 2025 at 05:24:55PM +0000, Graham Mullan wrote:
> Wookey wrote:
> > (we use *REF heavily to record where the original survey data for a survey
> > is to be found, for example).
> 
> I never knew that! Our data has a commented out line in each file which
> states the source of data

That's exactly the sort of thing `*ref` is intended for:

    Syntax
       ``*ref <string>``

    Example
       *ref "survey folder 2007#12"

    Validity
       valid at the start of a ``*begin``/``*end`` block.

    Description
       ``*ref`` allows you to specify a reference.  If the reference contains
       spaces, you must enclose it in double quotes.  Survex doesn't try
       to interpret the reference in any way, so it's up to you how you
       use it - for example it could specify where the original survey
       notes can be found.

       ``*ref`` was added in Survex 1.2.23.

The main advantage over a comment at present is that it's in a format
you can more easily search for.  It's not currently in the .3d file but
once it is there you'll also be able to view it for a survey in aven,
etc.

> and another commented out line, especially for historic data, which states
> when it was typed in.

Is that a date type that people would find useful as metadata more generally?
E.g. would you ever want to colour by the date someone type the data in?

1.4.13 added support for "surveyed" vs "explored" date, and this could be
extended to other useful types.

Note that only "surveyed" is in the .3d file currently, but once that's
addressed you'll be able to colour by explored date.

Cheers,
    Olly