Use <%doc> for head comments

diff --git a/yarrg/web/dataage b/yarrg/web/dataage
index 078c5e197085ef1c58b570cfba835d3e12af3ee2..313f892c72bb7a09d41c99e30019f1244ba78a4f 100644 (file)
--- a/yarrg/web/dataage
+++ b/yarrg/web/dataage
@@ -1,34 +1,38 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component generates the core of the `data age' query.
-%#
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component generates the core of the `data age' query.
+
+
+</%doc>

 <%once>
 my $meta_prettyprint_age= sub {
     my ($age,$floor,$plus) = @_;
 <%once>
 my $meta_prettyprint_age= sub {
     my ($age,$floor,$plus) = @_;

diff --git a/yarrg/web/docs b/yarrg/web/docs
index 18a1d1ab99166bc9a3efe7abb9dbb9c90431f571..dffdf7f8281e1b2ba040a4bc1360a1bcf8b55ed8 100755 (executable)
--- a/yarrg/web/docs
+++ b/yarrg/web/docs
@@ -1,34 +1,38 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component generates the documentation.
-%#
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component generates the documentation.
+
+
+</%doc>

 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
 </head><body>
 <& webcopyright &>
 <html><head><title>YARRG (Yet Another Revenue Research Gatherer)</title>
 </head><body>
 <& webcopyright &>

diff --git a/yarrg/web/footer b/yarrg/web/footer
index 9d5d77f64e93ad2fed091882b16f27a532330260..8af45ad7dcaeb530245fc9b081d4c166c3be8995 100644 (file)
--- a/yarrg/web/footer
+++ b/yarrg/web/footer
@@ -1,34 +1,38 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component is simply the page footer.
-%#
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component is simply the page footer.
+
+
+</%doc>

 <%args>
 $isdocs => 0
 </%args>
 <%args>
 $isdocs => 0
 </%args>

diff --git a/yarrg/web/lookup b/yarrg/web/lookup
index 41eda49db3359e0462a330245c3ce1468fe9b86d..9206d4b536b68629c6cd93f9bc928fdffe2e4eeb 100755 (executable)
--- a/yarrg/web/lookup
+++ b/yarrg/web/lookup
@@ -1,35 +1,39 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component generates the main `lookup' page, including
-%# all the entry boxes etc. for every query.
-%#
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component generates the main `lookup' page, including
+ all the entry boxes etc. for every query.
+
+
+</%doc>

 <%perl>
 my %a;
 my %ahtml;
 <%perl>
 my %a;
 my %ahtml;

diff --git a/yarrg/web/routetextstring b/yarrg/web/routetextstring
index a9a0de83d4bea26c2054b3256c9f5a3632a208c8..8787073c918ae89203ca06df7b4888244fc907fa 100755 (executable)
--- a/yarrg/web/routetextstring
+++ b/yarrg/web/routetextstring
@@ -1,35 +1,39 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component parses textual strings giving lists of islands
-%# and archipelagoes, ie textual route strings.
-%#
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component parses textual strings giving lists of islands
+ and archipelagoes, ie textual route strings.
+
+
+</%doc>

 <%args>
 $ocean
 $format
 <%args>
 $ocean
 $format

diff --git a/yarrg/web/source.tar.gz b/yarrg/web/source.tar.gz
index 43c5248d62854ea092938d3bbb409452f67ae10e..157b65fe5b6e4c36b90632d0900fa231fcf32d44 100755 (executable)
--- a/yarrg/web/source.tar.gz
+++ b/yarrg/web/source.tar.gz
@@ -1,36 +1,39 @@
-%# This is part of the YARRG website.  YARRG is a tool and website
-%# for assisting players of Yohoho Puzzle Pirates.
-%#
-%# Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
-%# Copyright (C) 2009 Clare Boothby
-%#
-%#  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
-%#  The YARRG website is covered by the GNU Affero GPL v3 or later, which
-%#   basically means that every installation of the website will let you
-%#   download the source.
-%#
-%# This program is free software: you can redistribute it and/or modify
-%# it under the terms of the GNU Affero 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 Affero General Public License for more details.
-%#
-%# You should have received a copy of the GNU Affero 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.
-%#
-%#
-%# This Mason component allows visitors to the YARRG website to download
-%# the YARRG website's source code.
-%#
-<%perl>
+<%doc>
+
+ This is part of the YARRG website.  YARRG is a tool and website
+ for assisting players of Yohoho Puzzle Pirates.
+
+ Copyright (C) 2009 Ian Jackson <ijackson@chiark.greenend.org.uk>
+ Copyright (C) 2009 Clare Boothby
+
+  YARRG's client code etc. is covered by the ordinary GNU GPL (v3 or later).
+  The YARRG website is covered by the GNU Affero GPL v3 or later, which
+   basically means that every installation of the website will let you
+   download the source.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero 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 Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero 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.
+
+
+ This Mason component allows visitors to the YARRG website to download
+ the YARRG website's source code.
+
+
+</%doc><%perl>

 use IO::Pipe;
 use CommodsWeb;
 
 use IO::Pipe;
 use CommodsWeb;