chiark / gitweb /
more updates to "upload" doc
[ypp-sc-tools.db-test.git] / yarrg / web / upload
index 109110bf65473a3f76b36440486df09322342508..2714dcd8aa4998a71135e0cb561e2cee57dae3c9 100755 (executable)
@@ -74,13 +74,12 @@ YPP client.  Then press "Upload" in the JPCTB window.
 <p>
 
 The JPCTB integration is done via fully supported Java Accessibility
-interfaces and without modifying the Puzzle Pirates client, and should
-not disturb the normal running of Puzzle Pirates.  However, please
-make sure that if your YPP client misbehaves in any way, you try
-running it in the vanilla way without JPCTB integration before asking
-for help.  In particular, if the JPCTB startup method does not work,
-but the vanilla client startup method does, report the problem to us,
-not to Three Rings.
+interfaces, and should not disturb the normal running of Puzzle
+Pirates.  However, please make sure that if your YPP client misbehaves
+at all, you try starting it in the vanilla way (without JPCTB
+integration) before asking for help.  In particular, if the JPCTB
+startup does not work, but the ordinary Puzzle Pirates startup does,
+report the problem to us, not to Three Rings.
 
 <h3>Installing and running on Linux</h3>
 
@@ -100,39 +99,40 @@ ordinary Puzzle Pirates startup script, which is normally
 Download
 <a href="http://www.greenend.org.uk/owen/free/jpctb-linkfarmer/jpctp-setup.exe">http://www.greenend.org.uk/owen/free/jpctb-linkfarmer/jpctp-setup.exe</a>
 and double-click on it.  It will either:
-<nl>
+<ol>
 <li>Just work, in which case you'll have a new icon on your desktop which
    runs Puzzle Pirates with JPCTB integrated.
 <li>Fail, and tell you what to do next.  Usually this means installing a
    Java Runtime Environment (or JVM) and then uninstalling and re-
    installing Puzzle Pirates.  (Don't worry about reinstalling; you
    won't lose any of your pirates or pieces of eight!)
-</nl>
+</ol>
 
 <h3>Installing on Macs</h3>
 
-We believe that it should be straightforward for a MacOS developer or
-expert to get YARRG JPCTB working properly on MacOS but we have not
-been able to test this ourselves.  The Linux installation method is
-probably the best starting point.
+We believe that it should be straightforward for a MacOS expert to get
+YARRG JPCTB working properly on MacOS but we have not been able to
+test this ourselves.  The Linux installation method is probably the
+best starting point.
 
 <h2>How does it work?  Is it a violation of the Terms of Service?</h2>
 
-YARRG JPCTB uses the Java Accessibility API, which is a part of the
-Java platform.  It's an interface provided for making applications
-available to users with disabilities, for example for hooking in
-screen readers.  This approach was helpfully suggested by a Ringer in
-the forums (to another developer of a third-party tool, wanting help
-getting information out of Duty Reports).
-
-<p>
-
 Essentially, JPCTB is a specialised "screen reader" which instead of
 reading information out loud, uploads it to the YARRG and PCTB
 databases.
 
 <p>
 
+YARRG JPCTB uses the Java Accessibility API, which is a part of the
+Java platform.  It's an facility in Java, available for all Java
+programs, intended to help make applications available to users with
+disabilities; for example, it permits hooking in screen readers.  The
+use of the Java Accessibility API was helpfully suggested by a Ringer
+in the forums (to another developer of a third-party tool, wanting
+help getting information out of Duty Reports).
+
+<p>
+
 Installing YARRG JPCTB does not modify any game files, and does not
 hook into the game itself.  It makes no permanent or global changes to
 your overall computer, operating system or Java configuration.  And it
@@ -155,7 +155,8 @@ Thanks to Burninator for writing the core of the JPCTB client.  Ian
 Jackson and Owen Dunn adapted it to improve the installation setup (in
 particular, to more completely avoid modifying the YPP client's
 startup files, which Three Rings unsurprisingly objected to).  Owen
-Dunn added support for uploading to YARRG and a Windows installer.
+Dunn added support for uploading to YARRG, updated the build system,
+and wrote a Windows installer.
 
 <p>