From: Ian Jackson <ian@liberator.relativity.greenend.org.uk>
Date: Sat, 12 Dec 2009 13:22:22 +0000 (+0000)
Subject: where-vessels: Add some section headings
X-Git-Tag: 6.3.0~6
X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~yarrgweb/git?p=ypp-sc-tools.db-test.git;a=commitdiff_plain;h=6fd881cafdc6f0b287a8d98379b3616be38e48a6

where-vessels: Add some section headings
---

diff --git a/yarrg/where-vessels b/yarrg/where-vessels
index 43d4a60..c0252a0 100755
--- a/yarrg/where-vessels
+++ b/yarrg/where-vessels
@@ -1,9 +1,36 @@
 #!/usr/bin/wish
+# show your vessels on a map
+
+# This is part of ypp-sc-tools, a set of third-party tools for assisting
+# players of Yohoho Puzzle Pirates.
+#
+# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+# Yohoho and Puzzle Pirates are probably trademarks of Three Rings and
+# are used without permission.  This program is not endorsed or
+# sponsored by Three Rings.
+
+
 
 source yarrglib.tcl
 source panner.tcl
 package require http
 
+#---------- general utilities ----------
+
 set debug 0
 proc debug {m} {
     global debug
@@ -15,6 +42,13 @@ proc badusage {m} {
     exit 1
 }
 
+proc glset {n val} {
+    upvar #0 $n var
+    set var $val
+}
+
+#---------- argument parsing ----------
+
 proc nextarg {} {
     global ai argv
     if {$ai >= [llength $argv]} {
@@ -25,11 +59,6 @@ proc nextarg {} {
     return $v
 }
 
-proc glset {n val} {
-    upvar #0 $n var
-    set var $val
-}
-
 set notes_loc vessel-notes
 set scraper {./yppedia-ocean-scraper --chart}
 
@@ -66,6 +95,9 @@ proc argdefaults {} {
     lappend scraper $ocean
 }
 
+
+#---------- loading and parsing the vessel notes ----------
+
 proc load-notes {} {
     global notes_loc notes
     catch { unset notes }
@@ -95,6 +127,8 @@ proc load-notes {} {
 }
 
 
+#---------- loading and parsing the clipboard (vessel locations) ----------
+
 proc vessel {vin} {
 	global pirate notes_used
 	upvar 1 $vin vi
@@ -187,6 +221,9 @@ proc load-clipboard-file {fn} {
     close $f
 }
 
+
+#---------- loading and parsing the chart ----------
+
 proc load-chart {} {
     global chart scraper
     debug "FETCHING CHART"
@@ -280,6 +317,8 @@ proc draw {} {
 }
 
 
+#---------- user interface ----------
+
 proc widgets-setup {} {
     global canvas debug
 
@@ -308,7 +347,6 @@ proc widgets-setup {} {
     wm geometry . 1024x480
 }
 
-
 proc zoom {extail} {
     global scale canvas
     set nscale [expr "\$scale $extail"]
@@ -320,6 +358,8 @@ proc zoom {extail} {
 }
 
 
+#---------- main program ----------
+
 parseargs
 argdefaults
 httpclientsetup where-vessels