[cairo-commit] roadster/data/help legal.xml, NONE,
1.1 roadster-help.xml, NONE, 1.1
Ian McIntosh
commit at pdx.freedesktop.org
Mon Sep 26 06:57:15 PDT 2005
Committed by: ian
Update of /cvs/cairo/roadster/data/help
In directory gabe:/tmp/cvs-serv5123/data/help
Added Files:
legal.xml roadster-help.xml
Log Message:
* data/help/roadster-help.xml:
* data/help/legal.xml:
* data/help/figures/window_layout.png: Added the basics of a help system.
* src/db.c: Removed debug stuff.
* src/glyph.c: Added glyph drawing (via gdk/pixbufs).
* src/location.c: Added location attribute name inserting / retrieving.
* src/locationset.c: Added 'icon' field.
* src/main.c: Add some debug code to insert test POI data.
* src/search.c: Removed knowledge of search result type icons. Now each type can provide its own.
* src/search_*.c: Provide an icon suggestion along with results.
* src/map.c:
* src/map_draw_gdk.c: Re-enable / fix POI drawing.
* src/point.c:
* src/pointstring.c:
* src/locationset.c: Fixed area_size of chunk allocators.
--- NEW FILE: legal.xml ---
<legalnotice id="legalnotice">
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
License (GFDL), Version 1.1 or any later version published
by the Free Software Foundation with no Invariant Sections,
no Front-Cover Texts, and no Back-Cover Texts. You can find
a copy of the GFDL at this <ulink type="help"
url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
distributed with this manual.
</para>
<para> This manual is part of a collection of GNOME manuals
distributed under the GFDL. If you want to distribute this
manual separately from the collection, you can do so by
adding a copy of the license to the manual, as described in
section 6 of the license.
</para>
<para>
Many of the names used by companies to distinguish their
products and services are claimed as trademarks. Where those
names appear in any GNOME documentation, and the members of
the GNOME Documentation Project are made aware of those
trademarks, then the names are in capital letters or initial
capital letters.
</para>
<para>
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
WITH THE FURTHER UNDERSTANDING THAT:
<orderedlist>
<listitem>
<para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
THAT THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
OF THE DOCUMENT OR MODIFIED VERSION OF THE
DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
EXCEPT UNDER THIS DISCLAIMER; AND
</para>
</listitem>
<listitem>
<para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
PARTIES, BE LIABLE TO ANY PERSON FOR ANY
DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES OF ANY CHARACTER
INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
LOSSES ARISING OUT OF OR RELATING TO USE OF THE
DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
THE POSSIBILITY OF SUCH DAMAGES.
</para>
</listitem>
</orderedlist>
</para>
</legalnotice>
--- NEW FILE: roadster-help.xml ---
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"[
<!ENTITY legal SYSTEM "legal.xml">
<!ENTITY appversion "0.4.0">
<!ENTITY manrevision "0.1">
<!ENTITY date "September 2005">
<!ENTITY app "Roadster">
]>
<article id="index" lang="en">
<!-- =============Document Header ============================= -->
<!-- please do not change the id; for translations, change lang to -->
<!-- appropriate code -->
<articleinfo>
<title>&app; Manual v&manrevision;</title>
<copyright>
<year>2005</year>
<holder>Ian McIntosh</holder>
</copyright>
<!-- translators: uncomment this:
<copyright>
<year>2005</year>
<holder>ME-THE-TRANSLATOR (Latin translation)</holder>
</copyright>
-->
<publisher>
<publishername>&app; Documentation Project</publishername>
</publisher>
&legal;
<authorgroup>
<author>
<firstname>Ian</firstname>
<surname>McIntosh</surname>
<affiliation>
<orgname>&app; Documentation Project</orgname>
<address><email>ian_mcintosh at linuxadvocate.org</email> </address>
</affiliation>
</author>
</authorgroup>
<!-- According to GNU FDL, revision history is mandatory if you are -->
<!-- modifying/reusing someone else's document. If not, you can omit it. -->
<revhistory>
<!-- Remember to remove the &manrevision; entity from the revision entries
other than the current revision. -->
<revision>
<revnumber>&app; Manual v&manrevision;</revnumber>
<date>&date;</date>
<revdescription>
<para role="author">Ian McIntosh</para>
<para role="publisher">&app; Documentation Project</para>
</revdescription>
</revision>
</revhistory>
<releaseinfo>This manual describes version &appversion; of &app;.</releaseinfo>
<legalnotice>
<title>Feedback</title>
<para>
To report a bug or offer feedback about
<application>&app;</application> or this help document, follow
the directions on the <ulink url="ghelp:gnome-feedback" type="help">
&app; Feedback Page</ulink>.
</para>
<!-- Translators may also add here feedback address for translations -->
</legalnotice>
</articleinfo>
<indexterm><primary>roadster</primary></indexterm>
<!-- ============= Document Body ============================= -->
<!-- ============= Introduction ============================== -->
<sect1 id="intro">
<title>Introduction</title>
<para>
<application>&app;</application> is desktop mapping software.
It was designed to be fun and useful for everyone, not just
highly technical people.
</para>
<para>
This document will help you go 0 to 60 in no time.
</para>
</sect1>
<!-- ======================Window Layout ===================== -->
<sect1 id="window-layout">
<title>Window Layout</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata fileref="figures/window_layout.png" format="PNG"/>
</imageobject>
</mediaobject>
</screenshot>
<para>
The main window. The individual parts of this window are described below.
</para>
<!-- ======================Toolbar ===================== -->
<sect2 id="toolbar">
<title>Toolbar</title>
<para>
The toolbar provides access to the most useful map navigation operations.
</para>
<itemizedlist>
<listitem>
<para>
<guibutton>Back Button.</guibutton> The Back button takes you to the last place you were looking at. It works in a similar way to the Back button in your web browser.
No matter how you move the map, clicking Back will undo the movement.
</para>
</listitem>
<listitem>
<para>
<guibutton>Forward Button.</guibutton> After using the Back button, you can click Forward to return to where you were. It works in a similar way to the Forward button in your web browser.
</para>
</listitem>
<listitem>
<para>
<guibutton>Zoom-Out Button.</guibutton> Zoom out one level. When you are zoomed out as far as possible, the button will be grayed out. and unavailable.
</para>
</listitem>
<listitem>
<para>
<guibutton>Zoom Slider.</guibutton> The slider allows you to quickly zoom to any level. Click and drag the slider to zoom.
</para>
</listitem>
<listitem>
<para>
<guibutton>Zoom-In Button.</guibutton> Zoom in one level. When you are zoomed in as far as possible, the button will be grayed out. and unavailable.
</para>
</listitem>
<listitem>
<para>
<guibutton>Search Entry.</guibutton> Read more about how to use the search, see the section titled <link linkend="search">How to Search</link>.
</para>
</listitem>
</itemizedlist>
<note>
<para>
Many of the operations available on the toolbar can also be performed using <link linkend="shortcuts">Shortcut Keys</link>.
</para>
</note>
</sect2>
<sect2 id="sidebar">
<title>Sidebar</title>
<para>
To read more about what information shows up on the sidebar and how to use it, head on over to the <link linkend="shortcuts">Using the Sidebar</link> section.
</para>
</sect2>
<sect2 id="map-area">
<title>Map Area</title>
<para>
insert text
</para>
</sect2>
<sect2 id="status-bar">
<title>Statusbar</title>
<para>
The status bar displays ...
</para>
</sect2>
</sect1>
<!-- ======================How to Search ===================== -->
<sect1 id="search">
<title>How to Search</title>
<para>
This section will show you how to perform searches in &app; and offers some tips for improving the results you get.
</para>
<sect2 id="search-basics">
<title>Search Basics</title>
<para>
To start a search, enter search words into the search box in the upper right corner of the main window, and then hit the Enter key on your keyboard. Some example searches you could try now:
</para>
<itemizedlist>
<listitem>120 Main Street, Orleans, Massachusetts</listitem>
<listitem>Buffalo Street, ND</listitem>
<listitem>Miami</listitem>
<listitem>Arizona</listitem>
<listitem>90210</listitem>
</itemizedlist>
<para>
After performing a search, the <link linkend="">search results sidebar tab</link> will automatically be displayed. Click on one of the results to view the location.
</para>
<note>
<para>
Don't worry about losing your current spot, you can use the <guibutton>Back Button</guibutton> to return to it later.
</para>
</note>
</sect2>
<sect2 id="finding-locations">
<title>Finding Places</title>
<para>
The search box can also find places like restaurants, schools, and police stations. Try these searches:
</para>
<itemizedlist>
<listitem>pizza in Portland, OR</listitem>
<listitem>coffee shop wifi Cambridge</listitem>
<listitem>gas</listitem>
</itemizedlist>
<para>
Notice that some searches have a city name in them. When you include a city name in your search, &app; will try to find Places in or near that city.
</para>
<para>
When you don't specify a city in your search, &app; will find Places nearby where you are currently looking.
</para>
</sect2>
<sect2 id="find-tips">
<title>Tips</title>
<itemizedlist>
<listitem>When searching in &app;, capitalization doesn't matter. The word PIZZA is treated the same as Pizza and even PiZZa. They will all get the same results.</listitem>
<listitem>Punctuation like commas, quotation marks, pluses, minuses, and parentheses are ignored.</listitem>
<listitem>Words like "in" or "near" are optional.</listitem>
<listitem>If you get too many search results, try adding more search words.</listitem>
<listitem>If you get too few search results, try removing one or more search words.</listitem>
</itemizedlist>
</sect2>
</sect1>
<!-- ======================Shortcuts ===================== -->
<sect1 id="shortcuts">
<title>Shortcut Keys</title>
<para>
You can use the keyboard to perform all of the operations
available in &app;. Most of these operations have a
keyboard shortcut. The available shortcuts are listed below.
</para>
<sect2 id="file-menu-shortcuts-section">
<title>Shortcut Table</title>
<table frame="topbot" id="file-menu-shortcuts-table">
<title></title>
<tgroup cols="2" colsep="0" rowsep="0">
<colspec colname="colspec0" colwidth="30*"/>
<colspec colname="colspec1" colwidth="70*"/>
<thead>
<row rowsep="1">
<entry valign="top">
<para>Shortcut</para>
</entry>
<entry valign="top">
<para>Description</para>
</entry>
</row>
</thead>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl+T</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Show or Hide the Toolbar</para>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl+S</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Show or Hide the Sidebar</para>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl+B</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Show or Hide the Statusbar</para>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl+-</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Zoom Out one level</para>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl+=</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Zoom In one level</para>
</entry>
</row>
</tbody>
<tbody>
<row>
<entry colname="colspec0" valign="top">
<para><keycap>Ctrl-Q</keycap></para>
</entry>
<entry colname="colspec1" valign="top">
<para>Close &app;</para>
</entry>
</row>
</tbody>
</tgroup>
</table>
<para>
TODO: Finish this list.
</para>
</sect2>
</sect1>
<!-- ======================About ===================== -->
<sect1 id="about">
<title>About Roadster</title>
<para>
The &app; project was started by Ian McIntosh in early 2005.
His goal was to create a Free Software alternative to the proprietary
mapping applications available at the time. He also hoped to make
something more fun to use, and to provide a platform on which
others could innovate.
</para>
<para>
&app; is distributed under the terms of the <ulink url="ghelp:gpl" type="help">GNU General
Public license</ulink> as published by the Free Software Foundation; either
version 2 of the License, or any later version.
</para>
</sect1>
</article>
More information about the cairo-commit
mailing list