[Viking-devel] [PATCH] Document VikSlippyMapSource
Add documentation related to protocol handled by VikSlippyMapSource. Signed-off-by: Guilhem Bonnefille guilhem.bonnefi...@gmail.com --- src/vikslippymapsource.c | 25 + 1 files changed, 25 insertions(+), 0 deletions(-) diff --git a/src/vikslippymapsource.c b/src/vikslippymapsource.c index 1c36cdc..c2b0b05 100644 --- a/src/vikslippymapsource.c +++ b/src/vikslippymapsource.c @@ -16,6 +16,31 @@ * You should have received a copy of the GNU General Public License along * with this program. If not, see http://www.gnu.org/licenses/. */ + + /** + * SECTION:vikslippymapsource + * @short_description: the class for SlippyMap oriented map sources + * + * The #VikSlippyMapSource class handles slippy map oriented map sources. + * The related service is tile oriented, Ã la Google. + * + * The tiles are in 'google spherical mercator', which is + * basically a mercator projection that assumes a spherical earth. + * http://docs.openlayers.org/library/spherical_mercator.html + * + * Such service is also a type of TMS (Tile Map Service) as defined in + * OSGeo's wiki. + * http://wiki.osgeo.org/wiki/Tile_Map_Service_Specification + * http://en.wikipedia.org/wiki/Tile_Map_Service + * But take care that the Y axis is inverted, ie the origin is at top-left + * corner. + * Following this specification, the protocol handled by this class + * follows the global-mercator profile. + * + * You can also find many interesting information on the OSM's wiki. + * http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames + */ + #ifdef HAVE_CONFIG_H #include config.h #endif -- tg: (c74aa9c..) t/tms/document-slippymap-class (depends on: master) -- Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing http://p.sf.net/sfu/novell-sfdev2dev ___ Viking-devel mailing list Viking-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/viking-devel Viking home page: http://viking.sf.net/
Re: [Viking-devel] [PATCH] Document VikSlippyMapSource
As you can see, as I invested some time in learning TMS related stuuf, I decided to add some documentation. Greg, as I know you're both interested in more documentation and have some knowledge of geographic stuff, can you give me your opinion about this documentation? PS: it is my really first Gtk-doc comment. I used this even if viking is not yet ready for gtk-doc, but seems a reasonable tool for documenting Gtk code. -- Guilhem BONNEFILLE -=- JID: gu...@im.apinc.org MSN: guilhem_bonnefi...@hotmail.com -=- mailto:guilhem.bonnefi...@gmail.com -=- http://nathguil.free.fr/ -- Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing http://p.sf.net/sfu/novell-sfdev2dev ___ Viking-devel mailing list Viking-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/viking-devel Viking home page: http://viking.sf.net/
Re: [Viking-devel] [PATCH] Document VikSlippyMapSource
Guilhem Bonnefille guilhem.bonnefi...@gmail.com writes: As you can see, as I invested some time in learning TMS related stuuf, I decided to add some documentation. Greg, as I know you're both interested in more documentation and have some knowledge of geographic stuff, can you give me your opinion about this documentation? will do - any reason you haven't pushed to master? PS: it is my really first Gtk-doc comment. I used this even if viking is not yet ready for gtk-doc, but seems a reasonable tool for documenting Gtk code. seems fine to me. pgp0fLJvwVID7.pgp Description: PGP signature -- Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing http://p.sf.net/sfu/novell-sfdev2dev ___ Viking-devel mailing list Viking-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/viking-devel Viking home page: http://viking.sf.net/
Re: [Viking-devel] [PATCH] Document VikSlippyMapSource
The wikipedia reference has no useful content; I'd delete it. I think vikslippymapsource.c probably does not support arbitrary TMS (meaning parsing the metadata and coping), but instead supports the common profile of how maps are available on the web. It would be great if there is a web reference to how osm and others do something other than what the TMS spec says. http://www.gdal.org/frmt_wms.html http://www.gdal.org/frmt_wms_openstreetmap_tms.xml http://wiki.openstreetmap.org/wiki/Setting_up_TMS pgpxiLJ5WN5fK.pgp Description: PGP signature -- Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing http://p.sf.net/sfu/novell-sfdev2dev ___ Viking-devel mailing list Viking-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/viking-devel Viking home page: http://viking.sf.net/
Re: [Viking-devel] [PATCH] Document VikSlippyMapSource
also, since osm is arguably one of the more important pseudo-TMS services: http://wiki.openstreetmap.org/wiki/Slippy_map_tilenames pgptwIS3OJROX.pgp Description: PGP signature -- Start uncovering the many advantages of virtual appliances and start using them to simplify application deployment and accelerate your shift to cloud computing http://p.sf.net/sfu/novell-sfdev2dev ___ Viking-devel mailing list Viking-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/viking-devel Viking home page: http://viking.sf.net/
