<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="guide.xslt"?>
<guide>

	<section name="intro" title="What is GeoDoc?">
		<p>
			In short, GeoDoc is a
			<em>geotagging</em>
			tool. GeoDoc
			automatically identifies place names in text and
			<em>anchors</em>
			each name to
			the place to which it is most likely to refer. GeoDoc's simple web
			interface allows you to quickly correct any mistakes made by the
			automatic tagger. Finally, you can export the geotagged text as XML
			or
			HTML.
		</p>
	</section>

	<section name="getting-started" title="Getting Started">
		<p>
			Just
			<a href="GeoDoc.html" target="_blank">click here</a>
			to launch GeoDoc. We think you'll find
			working with GeoDoc easy and intuitive. If you do get stuck, this guide
			should answer your question.
		</p>
		<p>
			After launching GeoDoc, you need to
			<a href="#import">import a document</a>. You then
			<a href="#cleaning">clean the document</a>, correcting any
			mistakes that GeoDoc made and confirming GeoDoc's correct tags. Finally, you
			can
			<a href="#export">export your geotagged document</a>.
		</p>
		<p>Happy tagging!</p>
	</section>

	<section name="import" title="How do I import text into GeoDoc?">
		<p>
			For text stored on your computer, click the
			<span class="gui-element">Load File...</span>
			button. Select the file you
			want to tag, then click
			<span class="gui-element">Submit</span>.
		</p>
		<p>
			For text on the Web, click the
			<span class="gui-element">Load URL...</span>
			button. Enter the URL of the document you want to tag, then click
			<span class="gui-element">Submit</span>.
		</p>
		<p>
			GeoDoc currently supports the following import formats:
			<ul>
				<li>plain text (.txt)</li>
				<li>HTML (.html)</li>
				<li>GeoText (.gtml)</li>
				<li>GeoDoc (.gdoc)</li>
			</ul>
		</p>
	</section>

	<section name="export" title="How do I export tagged text?">
		<p>
			Click the
			<span class="gui-element">Export as HTML</span>
			button to export the text in HTML format, or click the
			<span class="gui-element">Export as GTML(XML)</span>
			button to export the text in XML format.
		</p>
		<p>Your browser will then prompt you to save the document 
		   or open the document in another application.</p>
	</section>

	<section name="cleaning" title="Document Cleaning">
		<p>GeoDoc uses a number of intelligent heuristics to
			automatically geotag your text, but it is impossible to achieve the
			level of accuracy that humans are
			capable of. Therefore, you will need to confirm GeoDoc's tags and correct
			any mistakes. We hope that GeoDoc makes this process as quick and
			painless as possible.</p>
		<p>
			Most of the time, you can simply confirm that GeoDoc tagged a place
			name correctly. To do this, hover over the place name with your mouse
			and then
			click the
			<span class="gui-element">Accept</span>
			button (<img border="0" style="background: transparent url(DA551827B39390AB7B8FDFF2BC803EFE.cache.png) no-repeat scroll -64px 0px; width: 16px; height: 16px; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;" src="clear.cache.gif" />) 
			in the popup dialog. If the same name
			appears in multiple places,
			click the
			<span class="gui-element">Accept All</span>
			button (<img border="0" style="background: transparent url(DA551827B39390AB7B8FDFF2BC803EFE.cache.png) no-repeat scroll -80px 0px; width: 24px; height: 16px; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;" src="clear.cache.gif" />) to accept all instances of the name.
		</p>
		<p>
			GeoDoc occasionally makes three types of errors:
			<ul>
				<li>
					<a href="#add-place-name">Missing place names</a>
				</li>
				<li>
					<a href="#reject-place-name">Invalid tags</a>
				</li>
				<li>
					<a href="#anchor">Incorrect anchors</a>
				</li>
			</ul>
		</p>
	</section>

	<section name="add-place-name" title="What if GeoDoc missed a place name?">
		<p>
			If GeoDoc failed to tag a place name, select the name with your mouse
			then click the
			<span class="gui-element">Add Place Name</span>
			button (<img border="0" style="background: transparent url(DA551827B39390AB7B8FDFF2BC803EFE.cache.png) no-repeat scroll -48px 0px; width: 16px; height: 16px; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;" src="clear.cache.gif" />).
		</p>
	</section>

	<section name="reject-place-name"
		title="What if GeoDoc tagged a phrase that is not a place name?">
		<p>
			If GeoDoc tagged a non-place name, hover over the incorrect tag with
			your mouse and then click the
			<span class="gui-element">Reject</span>
			button (<img border="0" style="background: transparent url(DA551827B39390AB7B8FDFF2BC803EFE.cache.png) no-repeat scroll 0px 0px; width: 16px; height: 16px; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;" src="clear.cache.gif" />) in the popup dialog. If the same
			phrase is tagged incorrectly in multiple places, click the
			<span class="gui-element">Reject All</span>
			button (<img border="0" style="background: transparent url(DA551827B39390AB7B8FDFF2BC803EFE.cache.png) no-repeat scroll -16px 0px; width: 32px; height: 16px; -moz-background-clip: -moz-initial; -moz-background-origin: -moz-initial; -moz-background-inline-policy: -moz-initial;" src="clear.cache.gif" />) to reject all instances of the phrase.
		</p>
	</section>

	<section name="anchor"
		title="What if GeoDoc chose the wrong place?">
		<p>
			Click on the place name. You can either click on the correct anchor
			on the map or select it in the drop-down list on the
			<span class="gui-element">Where is...</span>
			dialog. The drop-down list is sorted with the system's
			most recommended places at the top and the least likely at the
			bottom. Finally, click the
			<span class="gui-element">Accept</span>
			or
			<span class="gui-element">Accept All</span>
			button to re-anchor the place name.
	    </p>
	    <p>If the correct place does not appear on the map or in the drop-down 
	       list, follow the instructions in <a href="#missing-anchor">the next
	       section</a>.
	    </p>
	    <div class="figure">
			<img src="validation1.jpg" />
			<div class="figure-caption">Screenshot of the <span class="gui-element">Where is...</span> dialog</div>
		</div>
	</section>

	<section name="missing-anchor" title="The correct place is not an option!">
		<p>
			If the place identified by a place name does not appear in the place
			name's
			<span class="gui-element">Where is...</span>
			dialog, there are two possible courses of action:
		</p>
		<ul><li>First, try to lookup the correct place in the
			<span class="gui-element">Geospatial Database Browser</span>. 
			Drag the correct place from the
			<span class="gui-element">Geospatial Database Browser</span>
			to the
			<span class="gui-element">Where is...</span>
			dialog.
		    <div class="figure">
				<img src="db-browser.jpg" alt="Screenshot" />
			    <div class="figure-caption">Screenshot of the <span class="gui-element">Geospatial Database Browser</span></div>
			</div></li>
		    <li>If you don't know the correct place or can't find it in 
		    GeoDoc's geospatial database, select "Other" in the drop-down 
		    list. This will leave the name unanchored but still tagged as 
		    a place name.</li>
		</ul>
	</section>
	
	<section name="anchor-to-other" title="Can I confirm a place name tag without chosing a place?">
		<p>Sure, just click on the place name to open the 
		    <span class="gui-element">Where is...</span> dialog, select 
		    "Other" in the drop-down list, and click 
		    <span class="gui-element">Accept</span>.
		</p>
	</section>

	<section name="colors" title="What's with all the colors?">
		<p>
			GeoDoc highlights phrases that it identifies as place names in
			<span class="placeName">yellow</span>. 
			In the course of cleaning the document, these highlights will
			change to reflect your actions. When you accept a place name without
			anchoring it, the highlight will turn
			<span class="placeName accepted">pink</span>
			to indicate that the place name has been accepted but still requires
			your attention. When you accept and anchor a place name, the
			highlight turns
			<span class="placeName anchored">gray</span>
			indicating that you are finished with it. The highlight will
			<span class="placeName rejected">disappear</span>
			when you reject a tagged phrase, but you can still click on the
			phrase to bring up the
			<span class="gui-element">Where is...</span>
			dialog if you change your mind.
		</p>
	</section>

	<section name="simple-errors" title="GeoDoc didn't tag X.  Why's it so dumb?">
		<p>There are several reasons that GeoDoc may not tag an
			"obvious" place name. First, GeoDoc intentionally skips certain place
			names - "Seattle" will not be tagged in "Seattle Mariners", for
			example. It may be that the place name is not in GeoDoc's database or
			that one of GeoDoc's heuristics incorrectly eliminated the name from
			consideration. </p>
	</section>
	
	<section name="exception" title="Ahhh!!! GeoDoc crashed! Now what?">
	    <p>GeoDoc is Beta software, which means that it has not been thoroughly 
	       tested in "the wild".  As a result, unexpected situations may arise
	       that cause the software to fail.  We apologize profusely for any 
	       inconvenience this may cause, but all is not lost.</p>
	    <p>In fact, you can usually save your progress <em>even after a failure</em>
	       by <a href="#export">exporting your document as XML</a>.  You can then
	       <a href="#import">import the XML document</a> and pick up where you left off.</p>
	    <p>If the error recurs or you're in a helpful mood, please 
	       <a href="mailto:geodocsupport@stottlerhenke.com">shoot us an email</a> with
	       the following information:
	         <ul>
	            <li>Approximate date/time of the failure</li>
	            <li>A description of what you were doing when the error occurred</li>
	            <li>The error message, if any</li>
	      </ul>
	    </p>
	       
	</section>
</guide>
