source: subversion/applications/editors/josm/plugins/pdfimport/README @ 30820

Last change on this file since 30820 was 23702, checked in by extropy, 9 years ago

PDF import plugin.

File size: 3.0 KB
RevLine 
[23702]1README
2======
3
4This is a plugin for extracting shapes from PDF files.
5Generally useful if you have a map in PDF file and want to automate data extraction.
6This plugin is available under the GPL licence (version 2.0 or later).
7Uses PDFClown library to parse PDF files, see http://sourceforge.net/projects/clown/ for more info.
8
9
10Layout
11======
12+--- src                                source of your plugin
13  |- images                             images your plugin needs
14  |- resources                          resources your plugin needs
15
16  README                                this file
17
18  GPL-v2.0.txt                          GPL version 2 license text
19  GPL-v3.0.txt                          GPL version 3 license text
20  build.xml                             deployment build file
21  build-dev.xml                         vevelopment build file - uses local version of PDFClown
22   
23 
24Build
25===== 
26A JOSM plugin is built as a single jar. We use ant to build.
27
28See build.xml in this directory and update the plugin specific properties in the
29configuration section.
30 
31
32Maintaining versions
33====================
34There are two versions maintained with each plugin:
35   1) the main version
36      This is the lowest JOSM version required by this plugin.
37      You have to manually set the plugins main version in the build script.
38      Set the property plugin.main.version in build.xml accordingly.
39
40   2) the build version
41      The build version is unique for every build of the plugin. It is equal
42      to the SVN revision of your plugin directory.
43
44 Both the main version and the build version are included in properties of the plugins
45 manifest:
46    Plugin-Version      the build version
47    Plugin-Mainversion  the main version
48
49 JOSM automatically detects whether a plugin needs to be upgraded. It compares the build
50 version of the currently installed plugin jar with the build version of the plugin jar in
51 the SVN. The main version is irrelevant for this process. 
52 
53 Making your plugin available to JOSM users
54 ===========================================
55 When a plugin jar is checked into SVN a script updates the plugins list on the JOSM wiki:
56   http://josm.openstreetmap.de/wiki/Plugins
57 JOSM retrieves the list of available plugins and their build versions from this list.
58
59            commit      publish               read
60                       meta data              meta data
61      Build  ==>  SVN  =======>  JOSM Wiki   <======= JOSM
62                   ^
63                   ==================================
64                            fetch current plugin jar
65 
66 Note that you have to manually publish (commit) your plugin jar. There is no nightly build
67 in place. Everything else (pulishing meta data, updating plugins in the client) is then handled
68 by automatic processes.
69
70See also
71========
72* Developing Plugins
73  http://josm.openstreetmap.de/wiki/DevelopersGuide/DevelopingPlugins
74 
75* List of JOSM Plugins
76  http://josm.openstreetmap.de/wiki/Plugins
77 
78 
79 
80     
81
82 
Note: See TracBrowser for help on using the repository browser.