template now sexytopo compatible

core/views/survex.py

@@ -51,63 +51,52 @@ SVXPATH = Path(settings.SURVEX_DATA)
 survextemplatefile = """; *** THIS IS A TEMPLATE FILE - NOT WHAT YOU MIGHT BE EXPECTING ***
 
 *** DO NOT SAVE THIS FILE WITHOUT RENAMING IT !! ***
-;[Stuff in square brackets is example text to be replaced with real data, 
-; removing the square brackets]
+;[Stuff in square brackets is example text to be replaced, every square bracket 
+; must be excised in order for the website to let you save the file]
+
+; A semicolon at the beginning of a line means its a comment - you can write anything 
+; you like after it without upsetting survex.
+; An asterisk means the line does something, proceed with caution
 
 *begin [surveyname]
 
 ; stations linked into other surveys (or likely to)
 *export [1 8 12 34]
 
-; Cave:
-; Area in cave/QM: 
-*title ""
+; Cave name or number:
+; Area in cave surveyed/QM:
+*title "" [full descriptive name for survex file - delete/ignore if you are already happy with the '*begin' name]
 *date [2040.07.04]            ;  <-- CHANGE THIS DATE
-*team ["Albert Aadvark"] Tape  ; <-- CHANGE THE NAMES, in quotes if more than one word
-*team [Badger] Notes 
+
+*team ["Albert Aadvark"] Tape  ; <-- CHANGE THE NAMES, in quotes if more than one word. 
+; Insert as many or few people/roles as you like. 
+; If someone is in this file the metres surveyed will be attributed to them.
+*team [Badger] Notes
 *team ["Fred Fossa"] insts
-*team [Grumpy] Pics 
+*team [Grumpy] Pics
 [*instrument tape "CUCC Fisco Ranger open reel"] ; <-- CHANGE THIS to actual instrument
-; Calibration: [Where, readings]
-*ref [2040#00]                ;  <-- CHANGE THIS TOO
-; the #number is on the clear pocket containing the original notes
+; Calibration: [Have you? Where?]
 
-; if using a tape:
-*calibrate tape +0.0	; +ve if tape was too short, -ve if too long
+*ref [2040#00]                ;  <-- WALLET NAME, CHANGE THIS TOO
+; the #number is on the clear plastic wallet containing the original notes
 
-; Centreline data
+; Centreline data - copy and paste from the exported Sexy Topo file, include the 'alias station' line
+; if there is a significant station maybe write a description? e.g. 'top of big boulder'. 
+; Put a semicolon before any text.
 *data normal from to length bearing gradient ignoreall
-[ 1   2    5.57	    034.5     -12.8 ]
+[ 1   2    5.57    034.5     -12.8 ] ; on top of boulder shaped like a rabbit
+
+; what colour nail polish?:
 
 ;-----------
-;recorded station details (leave commented out)
-;(NP=Nail Polish, LHW/RHW=Left/Right Hand Wall)
-;Station Left Right Up Down Description
-;[Red] nail varnish markings
-[;1   0.8   0     5.3   1.6  ; NP on boulder. pt 23 on foo survey ]
-[;2   0.3   1.2   6     1.2  ; NP '2' LHW ]
-[;3   1.3   0     3.4   0.2  ; Rock on floor - not refindable ]
 
-
-;LRUDs arranged into passage tubes
-;new *data command for each 'passage',
-;repeat stations and adjust numbers as needed
-*data passage station left right up down 
-;[ 1   0.8   0     5.3   1.6 ]
-;[ 2   0.3   1.2   6     1.2 ]
-*data passage station left right up down
-;[ 1   1.3   1.5   5.3   1.6 ]
-;[ 3   2.4   0     3.4   0.2 ]
-
-
-;-----------
 ;Question Mark List  ;(keep initial semi-colon on each line)
 ; The nearest-station is the name of the survey and station which are nearest to
 ; the QM. The resolution-station is either '-' to indicate that the QM hasn't
 ; been checked; or the name of the survey and station which push that QM. If a
 ; QM doesn't go anywhere, set the resolution-station to be the same as the
 ; nearest-station. Include any relevant details of how to find or push the QM in
-; the textual description.
+; the textual description. Remove square brackets.
 ;Serial number   grade(A/B/C/D/X)  nearest-station  resolution-station description
 ;[ QM1    A    surveyname.3    -    description of QM ]
 ;[ QM2    B    surveyname.5    -    description of QM ]
@@ -122,9 +111,48 @@ survextemplatefile = """; *** THIS IS A TEMPLATE FILE - NOT WHAT YOU MIGHT BE EX
 ;Cave description  ;(leave commented-out)
 ;Freeform text describing this section of the cave
 ; more free form text
-; lots of descrition please. It will be copied and pasted into the Cave data page.
+; lots of description please. It will be copied and pasted into the Cave data page.
 
 *end [surveyname]
+;------------------------------------------------------------------
+;------------------------------------------------------------------
+
+; if doing a manual, not sexytopo survey, then you will also need all the Splays and LRUDs
+; BEFORE the *end statement. If you are doing sexytopo then you should delete all this:
+
+; Splays arranged for each survey station (NB you only need to
+; explicitly flag splays if they are to named stations).
+;
+; Station splayID distance, heading, inclination
+*begin
+*flags splay
+;[ 1    1a   d    h    i]
+;[ 1    1b   d    h    i]
+;[ 3    3a   d    h    I]
+*end
+
+;------------------------------------------------------------------
+;LRUDS and recorded station details (leave commented out)
+;(NP=Nail Polish, LHW/RHW=Left/Right Hand Wall)
+;Station Left Right Up Down Description
+;[Red] nail varnish markings
+
+*data passage station left right up down ignoreall ; THIS IS PASSAGE 1
+;[1   0.8   0     5.3   1.6  NP on boulder. pt 23 on foo survey ]
+;[2   0.3   1.2   6     1.2  NP '2' LHW ]
+;[3   1.3   0     3.4   0.2  Rock on floor - not refindable ]
+
+*data ; THIS IS PASSAGE 2 - REPEAT CONNECTED LRUD
+;[1   0.8   0     5.3   1.6  NP on boulder. pt 23 on foo survey ]
+;[2   0.3   1.2   6     1.2  NP '2' LHW ]
+;[3   1.3   0     3.4   0.2  Rock on floor - not refindable ]
+
+*data ; THIS IS PASSAGE 3 - REPEAT CONNECTED LRUD
+;[1   0.8   0     5.3   1.6  NP on boulder. pt 23 on foo survey ]
+;[2   0.3   1.2   6     1.2  NP '2' LHW ]
+;[3   1.3   0     3.4   0.2  Rock on floor - not refindable ]
+
+
 """
 
 def get_survexfile(filename):