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

Last change on this file since 33579 was 32520, checked in by donvip, 3 years ago

update to PDFBox 1.8.12

File size: 2.9 KB
Line 
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 PDFBox library to parse PDF files, see https://pdfbox.apache.org 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
22 
23Build
24===== 
25A JOSM plugin is built as a single jar. We use ant to build.
26
27See build.xml in this directory and update the plugin specific properties in the
28configuration section.
29 
30
31Maintaining versions
32====================
33There are two versions maintained with each plugin:
34   1) the main version
35      This is the lowest JOSM version required by this plugin.
36      You have to manually set the plugins main version in the build script.
37      Set the property plugin.main.version in build.xml accordingly.
38
39   2) the build version
40      The build version is unique for every build of the plugin. It is equal
41      to the SVN revision of your plugin directory.
42
43 Both the main version and the build version are included in properties of the plugins
44 manifest:
45    Plugin-Version      the build version
46    Plugin-Mainversion  the main version
47
48 JOSM automatically detects whether a plugin needs to be upgraded. It compares the build
49 version of the currently installed plugin jar with the build version of the plugin jar in
50 the SVN. The main version is irrelevant for this process. 
51 
52 Making your plugin available to JOSM users
53 ===========================================
54 When a plugin jar is checked into SVN a script updates the plugins list on the JOSM wiki:
55   http://josm.openstreetmap.de/wiki/Plugins
56 JOSM retrieves the list of available plugins and their build versions from this list.
57
58            commit      publish               read
59                       meta data              meta data
60      Build  ==>  SVN  =======>  JOSM Wiki   <======= JOSM
61                   ^
62                   ==================================
63                            fetch current plugin jar
64 
65 Note that you have to manually publish (commit) your plugin jar. There is no nightly build
66 in place. Everything else (pulishing meta data, updating plugins in the client) is then handled
67 by automatic processes.
68
69See also
70========
71* Developing Plugins
72  http://josm.openstreetmap.de/wiki/DevelopersGuide/DevelopingPlugins
73 
74* List of JOSM Plugins
75  http://josm.openstreetmap.de/wiki/Plugins
Note: See TracBrowser for help on using the repository browser.