##tool.name##

├── examples └── README ├── resources ├── code │ ├── ExampleTaglet.class │ ├── ant-contrib-1.0b3.jar │ ├── doc.sh │ └── ExampleTaglet.java ├── install_instructions.txt ├── tool.properties ├── stylesheet.css ├── build.properties └── build.xml ├── .classpath ├── lib └── README ├── .project ├── license.txt ├── src └── template │ └── tool │ └── HelloTool.java ├── web ├── stylesheet.css └── index.html ├── data └── README └── README.md /examples/README: -------------------------------------------------------------------------------- 1 | add examples for your tool here. -------------------------------------------------------------------------------- /resources/code/ExampleTaglet.class: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lemio/CMDuino-tool/master/resources/code/ExampleTaglet.class -------------------------------------------------------------------------------- /resources/code/ant-contrib-1.0b3.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lemio/CMDuino-tool/master/resources/code/ant-contrib-1.0b3.jar -------------------------------------------------------------------------------- /.classpath: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /lib/README: -------------------------------------------------------------------------------- 1 | The lib folder: 2 | In case your tool requires 3rd party libraries, which need to be 3 | added to the distribution, put them into the lib folder. 4 | These 3rd party libraries will be added to your distribution and are 5 | located next to your tool's jar file. 6 | 7 | This does not apply to .jar files that are considered core processing libraries. -------------------------------------------------------------------------------- /.project: -------------------------------------------------------------------------------- 1 | 2 | 3 | processing-tool-template 4 | 5 | 6 | 7 | 8 | 9 | org.eclipse.jdt.core.javabuilder 10 | 11 | 12 | 13 | 14 | 15 | org.eclipse.jdt.core.javanature 16 | 17 | 18 | -------------------------------------------------------------------------------- /resources/code/doc.sh: -------------------------------------------------------------------------------- 1 | # a shell script to create a java documentation 2 | # for a processing library. 3 | # 4 | # make changes to the variables below so they 5 | # fit the structure of your library 6 | 7 | # the package name of your library 8 | package=template; 9 | 10 | # source folder location 11 | src=../src; 12 | 13 | # the destination folder of your documentation 14 | dest=../documentation; 15 | 16 | 17 | # compile the java documentation 18 | javadoc -d $dest -stylesheetfile ./stylesheet.css -sourcepath ${src} ${package} 19 | -------------------------------------------------------------------------------- /license.txt: -------------------------------------------------------------------------------- 1 | A code template to build tools for the Processing programming environment. 2 | 3 | Part of the Processing project - http://processing.org 4 | 5 | Copyright (c) 2011-12 Elie Zananiri 6 | Copyright (c) 2008-11 Andreas Schlegel 7 | 8 | This program is free software; you can redistribute it and/or 9 | modify it under the terms of the GNU General Public License 10 | as published by the Free Software Foundation; either version 2 11 | of the License, or (at your option) any later version. 12 | 13 | This program is distributed in the hope that it will be useful, 14 | but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 16 | GNU General Public License for more details. 17 | 18 | You should have received a copy of the GNU General Public License 19 | along with this program; if not, write to the Free Software 20 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -------------------------------------------------------------------------------- /resources/install_instructions.txt: -------------------------------------------------------------------------------- 1 | How to install tool ##tool.name## 2 | 3 | 4 | Install with the "Add Tool..." tool 5 | 6 | New for Processing 2.0: Add contributed tools by selecting "Add Tool..." 7 | from the Tool menu. Not all available tools have been converted to show up in 8 | this menu. If a tool isn't there, it will need to be installed manually by 9 | following the instructions below. 10 | 11 | 12 | Manual Install 13 | 14 | Contributed tools must be downloaded separately and manually placed within the 15 | "tools" folder of your Processing sketchbook. To find (and change) the 16 | Processing sketchbook location on your computer, open the Preferences window 17 | from the Processing application (PDE) and look for the "Sketchbook location" 18 | item at the top. 19 | 20 | Copy the contributed tool's folder into the "tools" folder at this location. 21 | You will need to create the "tools" folder if this is your first contributed 22 | tool. 23 | 24 | By default the following locations are used for your sketchbook folder: 25 | 26 | For Mac users, the sketchbook folder is located inside ~/Documents/Processing. 27 | For Windows users, the sketchbook folder is located inside 28 | 'My Documents'/Processing. 29 | 30 | The folder structure for tool ##tool.name## should be as follows: 31 | 32 | Processing 33 | tools 34 | ##tool.name## 35 | examples 36 | tool 37 | ##tool.name##.jar 38 | reference 39 | src 40 | 41 | Some folders like "examples" or "src" might be missing. After tool ##tool.name## 42 | has been successfully installed, restart the Processing application. 43 | -------------------------------------------------------------------------------- /src/template/tool/HelloTool.java: -------------------------------------------------------------------------------- 1 | /** 2 | * you can put a one sentence description of your tool here. 3 | * 4 | * ##copyright## 5 | * 6 | * This library is free software; you can redistribute it and/or 7 | * modify it under the terms of the GNU Lesser General Public 8 | * License as published by the Free Software Foundation; either 9 | * version 2.1 of the License, or (at your option) any later version. 10 | * 11 | * This library is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 | * Lesser General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU Lesser General 17 | * Public License along with this library; if not, write to the 18 | * Free Software Foundation, Inc., 59 Temple Place, Suite 330, 19 | * Boston, MA 02111-1307 USA 20 | * 21 | * @author ##author## 22 | * @modified ##date## 23 | * @version ##version## 24 | */ 25 | 26 | package template.tool; 27 | 28 | import processing.app.*; 29 | import processing.app.tools.*; 30 | 31 | 32 | 33 | public class HelloTool implements Tool { 34 | 35 | // when creating a tool, the name of the main class which implements Tool 36 | // must be the same as the value defined for project.name in your build.properties 37 | 38 | 39 | public String getMenuTitle() { 40 | return "Hello Tool"; 41 | } 42 | 43 | public void init(Editor theEditor) { 44 | } 45 | 46 | public void run() { 47 | System.out.println("hello Tool. ##name## ##version## by ##author##"); 48 | } 49 | 50 | } 51 | 52 | 53 | 54 | -------------------------------------------------------------------------------- /resources/tool.properties: -------------------------------------------------------------------------------- 1 | # More on this file here: https://github.com/processing/processing/wiki/Tool-Basics 2 | # UTF-8 supported. 3 | 4 | # The name of your tool as you want it formatted. 5 | name = ##tool.name## 6 | 7 | # List of authors. Links can be provided using the syntax [author name](url). 8 | authorList = [##author.name##](##author.url##) 9 | 10 | # A web page for your tool, NOT a direct link to where to download it. 11 | url = ##tool.url## 12 | 13 | # The category of your tool, must be one (or many) of the following: 14 | # "3D" "Animation" "Compilations" "Data" 15 | # "Fabrication" "Geometry" "GUI" "Hardware" 16 | # "I/O" "Language" "Math" "Simulation" 17 | # "Sound" "Utilities" "Typography" "Video & Vision" 18 | # 19 | # If a value other than those listed is used, your tool will listed as "Other". 20 | category = ##tool.category## 21 | 22 | # A short sentence (or fragment) to summarize the tool's function. This will be 23 | # shown from inside the PDE when the tool is being installed. Avoid repeating 24 | # the name of your tool here. Also, avoid saying anything redundant like 25 | # mentioning that it's a tool. This should start with a capitalized letter, and 26 | # end with a period. 27 | sentence = ##tool.sentence## 28 | 29 | # Additional information suitable for the Processing website. The value of 30 | # 'sentence' always will be prepended, so you should start by writing the 31 | # second sentence here. If your tool only works on certain operating systems, 32 | # mention it here. 33 | paragraph = ##tool.paragraph## 34 | 35 | # Links in the 'sentence' and 'paragraph' attributes can be inserted using the 36 | # same syntax as for authors. 37 | # That is, [here is a link to Processing](http://processing.org/) 38 | 39 | 40 | # A version number that increments once with each release. This is used to 41 | # compare different versions of the same tool, and check if an update is 42 | # available. You should think of it as a counter, counting the total number of 43 | # releases you've had. 44 | version = ##tool.version## # This must be parsable as an int 45 | 46 | # The version as the user will see it. If blank, the version attribute will be 47 | # used here. 48 | prettyVersion = ##tool.prettyVersion## # This is treated as a String 49 | -------------------------------------------------------------------------------- /web/stylesheet.css: -------------------------------------------------------------------------------- 1 | /* processingLibs style by andreas schlegel, sojamo. */ 2 | 3 | 4 | * { 5 | margin:0; 6 | padding:0; 7 | border:0; 8 | } 9 | 10 | 11 | body { 12 | font-family : Verdana, Geneva, Arial, Helvetica, sans-serif; 13 | font-size : 100%; 14 | font-size : 0.70em; 15 | font-weight : normal; 16 | line-height : normal; 17 | } 18 | 19 | 20 | 21 | #container { 22 | margin-left:64px; 23 | background-color:#fff; 24 | } 25 | 26 | #header { 27 | float:left; 28 | padding-top:24px; 29 | padding-bottom:48px; 30 | } 31 | 32 | #menu { 33 | margin-top:16px; 34 | float:left; 35 | margin-bottom:64px; 36 | } 37 | 38 | 39 | #about, 40 | #download, 41 | #examples, 42 | #demos, 43 | #misc { 44 | width:480px; 45 | float:left; 46 | margin-right:24px; 47 | } 48 | 49 | 50 | #resources, #info { 51 | width:320px; 52 | float:left; 53 | } 54 | 55 | 56 | .clear { 57 | clear:both; 58 | } 59 | 60 | #footer { 61 | margin-top:300px; 62 | height:20px; 63 | margin-bottom:32px; 64 | } 65 | 66 | 67 | ul { 68 | list-style:none; 69 | padding:0; 70 | margin:0; 71 | } 72 | 73 | 74 | #menu ul li, #subMenu ul li { 75 | float:left; 76 | padding-right:6px; 77 | } 78 | 79 | 80 | 81 | 82 | 83 | 84 | /* Headings */ 85 | 86 | h1 { 87 | font-size:2em; 88 | font-weight:normal; 89 | } 90 | 91 | 92 | h2, h3, h4, h5, th { 93 | font-size:1.3em; 94 | font-weight:normal; 95 | margin-bottom:4px; 96 | } 97 | 98 | 99 | 100 | p { 101 | font-size:1em; 102 | width:90%; 103 | margin-bottom:32px; 104 | } 105 | 106 | 107 | pre, code { 108 | font-family:"Courier New", Courier, monospace; 109 | font-size:1em; 110 | line-height:normal; 111 | } 112 | 113 | 114 | 115 | 116 | hr { 117 | border:0; 118 | height:1px; 119 | margin-bottom:24px; 120 | } 121 | 122 | 123 | a { 124 | text-decoration: underline; 125 | font-weight: normal; 126 | } 127 | 128 | 129 | a:hover, 130 | a:active { 131 | text-decoration: underline; 132 | font-weight: normal; 133 | } 134 | 135 | 136 | a:visited, 137 | a:link:visited { 138 | text-decoration: underline; 139 | font-weight: normal; 140 | } 141 | 142 | 143 | 144 | img { 145 | border: 0px solid #000000; 146 | } 147 | 148 | 149 | 150 | 151 | 152 | /* COLORS */ 153 | 154 | 155 | body { 156 | color : #333; 157 | background-color :#fff; 158 | } 159 | 160 | 161 | #header { 162 | background-color:#fff; 163 | color:#333; 164 | } 165 | 166 | 167 | 168 | h1, h2, h3, h4, h5, h6 { 169 | color:#666; 170 | } 171 | 172 | 173 | pre, code { 174 | color: #000000; 175 | } 176 | 177 | 178 | a,strong { 179 | color: #333; 180 | } 181 | 182 | 183 | a:hover, 184 | a:active { 185 | color: #333; 186 | } 187 | 188 | 189 | a:visited, 190 | a:link:visited { 191 | color: #333; 192 | } 193 | 194 | 195 | #footer, #menu { 196 | background-color:#fff; 197 | color:#333; 198 | } 199 | 200 | 201 | #footer a, #menu a { 202 | color:#333; 203 | } 204 | -------------------------------------------------------------------------------- /data/README: -------------------------------------------------------------------------------- 1 | The data folder: 2 | If your tool is using files like images, sound files, any data file, etc., 3 | put them into the data folder. When writing your tool you can use the 4 | following methods as a starting point to load or get files from the data folder, 5 | these are suggestions amongst many other solutions. 6 | 7 | When using an Object which extends PApplet inside your tool, PApplet's internal 8 | methods such as loadImage, loadStrings, etc. will use your tool's data folder to find 9 | files to be loaded. 10 | 11 | 12 | 13 | 14 | 15 | /** 16 | * load an image from the data folder or an absolute path. This 17 | * java.awt.Image can be displayed within a JFrame for example. 18 | * 19 | * @param theFilename 20 | * @return 21 | */ 22 | public Image loadImage(String theFilename) { 23 | if (theFilename.startsWith(File.separator)) { 24 | return new ImageIcon(theFilename).getImage(); 25 | } else { 26 | URL img = this.getClass().getResource(getPath(theFilename)); 27 | return new ImageIcon(img).getImage(); 28 | } 29 | } 30 | 31 | 32 | /** 33 | * load an image from the data folder or an absolute path as a PImage. 34 | * 35 | * @param theFilename 36 | * @return 37 | */ 38 | public PImage loadPImage(String theFilename) { 39 | return new PImage(loadImage(theFilename)); 40 | } 41 | 42 | 43 | /** 44 | * load a text file from the data folder or an absolute path. 45 | * 46 | * @param theFilename 47 | * @return 48 | */ 49 | public String loadString(String theFilename) { 50 | InputStream is = null; 51 | if (theFilename.startsWith(File.separator)) { 52 | try { 53 | is = new FileInputStream(loadFile(theFilename)); 54 | } catch (FileNotFoundException e) { 55 | System.err.println("ERROR @ loadString() " + e); 56 | } 57 | } else { 58 | is = getClass().getResourceAsStream(getPath(theFilename)); 59 | } 60 | InputStreamReader isr = new InputStreamReader(is); 61 | BufferedReader br = new BufferedReader(isr); 62 | int buffer; 63 | String result = ""; 64 | try { 65 | while ((buffer = br.read()) != -1) { 66 | result += (char) buffer; 67 | } 68 | } catch (Exception e) { 69 | System.err.println("ERROR @ loadString() " + e); 70 | } 71 | return result; 72 | } 73 | 74 | 75 | /** 76 | * getPath will return the path to a file or folder inside the data folder 77 | * of the tool or an absolute path. 78 | * 79 | * @param theFilename 80 | * @return 81 | */ 82 | public String getPath(String theFilename) { 83 | if (theFilename.startsWith("/")) { 84 | return theFilename; 85 | } 86 | return File.separator + "data" + File.separator + theFilename; 87 | } 88 | 89 | 90 | /** 91 | * load a file from the data folder or an absolute path. 92 | * 93 | * @param theFilename 94 | * @return 95 | */ 96 | public File loadFile(String theFilename) { 97 | if (theFilename.startsWith(File.separator)) { 98 | return new File(theFilename); 99 | } 100 | String path = getClass().getResource(getPath(theFilename)).getPath(); 101 | return new File(path); 102 | } 103 | 104 | 105 | 106 | 107 | 108 | -------------------------------------------------------------------------------- /resources/stylesheet.css: -------------------------------------------------------------------------------- 1 | /* Javadoc style sheet */ 2 | /* Define colors, fonts and other style attributes here to override the defaults */ 3 | /* processingLibs style by andreas schlegel, sojamo */ 4 | 5 | 6 | body { 7 | margin : 0; 8 | padding : 0; 9 | padding-left : 10px; 10 | padding-right : 8px; 11 | background-color : #FFFFFF; 12 | font-family : Verdana, Geneva, Arial, Helvetica, sans-serif; 13 | font-size : 100%; 14 | font-size : 0.7em; 15 | font-weight : normal; 16 | line-height : normal; 17 | margin-bottom:30px; 18 | } 19 | 20 | 21 | 22 | 23 | /* Headings */ 24 | h1, h2, h3, h4, h5, th { 25 | font-family :Arial, Helvetica, sans-serif; 26 | font-size:1.2em; 27 | } 28 | 29 | 30 | p { 31 | font-size : 1em; 32 | width:80%; 33 | } 34 | 35 | pre, code { 36 | font-family : "Courier New", Courier, monospace; 37 | font-size : 12px; 38 | line-height : normal; 39 | } 40 | 41 | 42 | 43 | table { 44 | border:0; 45 | margin-bottom:10px; 46 | margin-top:10px; 47 | } 48 | 49 | 50 | tr, td { 51 | border-top: 0px solid; 52 | border-left: 0px solid; 53 | padding-top:8px; 54 | padding-bottom:8px; 55 | } 56 | 57 | 58 | 59 | hr { 60 | border:0; 61 | height:1px; 62 | padding:0; 63 | margin:0; 64 | margin-bottom:4px; 65 | 66 | } 67 | 68 | 69 | 70 | dd, th, td, font { 71 | font-size:1.0em; 72 | line-height:1.0em; 73 | } 74 | 75 | 76 | 77 | dt { 78 | margin-bottom:0px; 79 | } 80 | 81 | 82 | 83 | dd { 84 | margin-top:2px; 85 | margin-bottom:4px; 86 | } 87 | 88 | 89 | 90 | a { 91 | text-decoration: underline; 92 | font-weight: normal; 93 | } 94 | 95 | a:hover, 96 | a:active { 97 | text-decoration: underline; 98 | font-weight: normal; 99 | } 100 | 101 | a:visited, 102 | a:link:visited { 103 | text-decoration: underline; 104 | font-weight: normal; 105 | } 106 | 107 | 108 | img { 109 | border: 0px solid #000000; 110 | } 111 | 112 | 113 | 114 | /* Navigation bar fonts */ 115 | .NavBarCell1 { 116 | border:0; 117 | } 118 | 119 | .NavBarCell1Rev { 120 | border:0; 121 | } 122 | 123 | .NavBarFont1 { 124 | font-family: Arial, Helvetica, sans-serif; 125 | font-size:1.1em; 126 | } 127 | 128 | 129 | .NavBarFont1 b { 130 | font-weight:normal; 131 | } 132 | 133 | 134 | 135 | .NavBarFont1:after, .NavBarFont1Rev:after { 136 | font-weight:normal; 137 | content: " \\"; 138 | } 139 | 140 | 141 | .NavBarFont1Rev { 142 | font-family: Arial, Helvetica, sans-serif; 143 | font-size:1.1em; 144 | } 145 | 146 | .NavBarFont1Rev b { 147 | font-family: Arial, Helvetica, sans-serif; 148 | font-size:1.1em; 149 | font-weight:normal; 150 | } 151 | 152 | .NavBarCell2 { 153 | font-family: Arial, Helvetica, sans-serif; 154 | } 155 | 156 | .NavBarCell3 { 157 | font-family: Arial, Helvetica, sans-serif; 158 | } 159 | 160 | 161 | 162 | font.FrameItemFont { 163 | font-family: Helvetica, Arial, sans-serif; 164 | font-size:1.1em; 165 | line-height:1.1em; 166 | } 167 | 168 | font.FrameHeadingFont { 169 | font-family: Helvetica, Arial, sans-serif; 170 | line-height:32px; 171 | } 172 | 173 | /* Font used in left-hand frame lists */ 174 | .FrameTitleFont { 175 | font-family: Helvetica, Arial, sans-serif 176 | } 177 | 178 | 179 | .toggleList { 180 | padding:0; 181 | margin:0; 182 | margin-top:12px; 183 | } 184 | 185 | .toggleList dt { 186 | font-weight:bold; 187 | font-size:12px; 188 | font-family:arial,sans-serif; 189 | padding:0px; 190 | margin:10px 0px 10px 0px; 191 | } 192 | 193 | .toggleList dt span { 194 | font-family: monospace; 195 | padding:0; 196 | margin:0; 197 | } 198 | 199 | 200 | .toggleList dd { 201 | margin:0; 202 | padding:0; 203 | } 204 | 205 | html.isjs .toggleList dd { 206 | display: none; 207 | } 208 | 209 | .toggleList pre { 210 | padding: 4px 4px 4px 4px; 211 | } 212 | 213 | 214 | 215 | 216 | 217 | /* COLORS */ 218 | 219 | pre, code { 220 | color: #000000; 221 | } 222 | 223 | 224 | body { 225 | color : #333333; 226 | background-color :#FFFFFF; 227 | } 228 | 229 | 230 | h1, h2, h3, h4, h5, h6 { 231 | color:#555; 232 | } 233 | 234 | a, 235 | .toggleList dt { 236 | color: #1a7eb0; 237 | } 238 | 239 | a:hover, 240 | a:active { 241 | color: #1a7eb0; 242 | } 243 | 244 | a:visited, 245 | a:link:visited { 246 | color: #1a7eb0; 247 | } 248 | 249 | td,tr { 250 | border-color: #999999; 251 | } 252 | 253 | hr { 254 | color:#999999; 255 | background:#999999; 256 | } 257 | 258 | 259 | .TableHeadingColor { 260 | background: #dcdcdc; 261 | color: #555; 262 | } 263 | 264 | 265 | .TableSubHeadingColor { 266 | background: #EEEEFF 267 | } 268 | 269 | .TableRowColor { 270 | background: #FFFFFF 271 | } 272 | 273 | 274 | .NavBarCell1 { 275 | background-color:#dcdcdc; 276 | color:#000; 277 | } 278 | 279 | .NavBarCell1 a { 280 | color:#333; 281 | } 282 | 283 | 284 | .NavBarCell1Rev { 285 | background-color:transparent; 286 | } 287 | 288 | .NavBarFont1 { 289 | color:#333; 290 | } 291 | 292 | 293 | .NavBarFont1Rev { 294 | color:#fff; 295 | } 296 | 297 | .NavBarCell2 { 298 | background-color:#999; 299 | } 300 | 301 | .NavBarCell2 a { 302 | color:#fff; 303 | } 304 | 305 | 306 | 307 | .NavBarCell3 { 308 | background-color:#dcdcdc; 309 | } 310 | 311 | -------------------------------------------------------------------------------- /web/index.html: -------------------------------------------------------------------------------- 1 | 3 | 4 | 5 | ##tool.name## 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 |

21 | 22 | 25 | 26 | 38 | 39 |

40 | 41 |

42 |

##tool.name##

43 |

44 | A tool by ##author.name## for the Processing programming environment.
45 | Last update, ##date##. 46 |

47 |

48 | ##tool.sentence##
49 | ##tool.paragraph##
50 | Feel free to replace this paragraph with a description of the tool.
51 | Contributed libraries are developed, documented, and maintained by members of the Processing community. Further directions are included with each tool. For feedback and support, please post to the Discourse. We strongly encourage all libraries to be open source, but not all of them are. 52 |

53 |

54 | 55 | 56 | 57 |

58 |

Download

59 |

60 | Download ##tool.name## version ##tool.prettyVersion## (##tool.version##) in 61 | .zip format. 62 |

63 |

Installation

64 |

65 | Unzip and put the extracted ##project.name## folder into the tools folder of your Processing sketches. Reference and examples are included in the ##project.name## folder. 66 |

67 |

68 | 69 | 70 |

71 |

Keywords. ##tool.keywords##

72 |

Reference. Have a look at the javadoc reference here. A copy of the reference is included in the .zip as well.

73 |

Source. The source code of ##tool.name## is available at ##source.host##, and its repository can be browsed here.

74 |

75 | 76 | 77 |

78 |

Examples

79 |

Find a list of examples in the current distribution of ##tool.name##, or have a look at them by following the links below.

80 |

81 | ##examples## 82 | 83 |

84 | 85 | 86 |

87 |

Tested

88 |

89 | 90 | Platform ##tested.platform## 91 | 92 | 93 |
Processing ##tested.processingVersion## 94 | 95 | 96 |
Dependencies ##tool.dependencies## 97 |

98 |

99 | 100 | 101 | 102 | 114 | 115 | 116 | 121 | 122 | 123 | 127 | 128 | 129 |
130 |

131 | 132 | 135 |

136 | 137 | -------------------------------------------------------------------------------- /resources/build.properties: -------------------------------------------------------------------------------- 1 | # Create tools for the Processing open source programming language and 2 | # environment (http://www.processing.org) 3 | # 4 | # Customize the build properties to make the ant-build-process work for your 5 | # environment. How? Please read the comments below. 6 | # 7 | # The default properties are set for OSX, for Windows-settings please refer to 8 | # comments made under (1) and (2). 9 | 10 | 11 | 12 | # (1) 13 | # Where is your Processing sketchbook located? 14 | # If you are not sure, check the sketchbook location in your Processing 15 | # application preferences. 16 | # ${user.home} points the compiler to your home directory. 17 | # For windows the default path to your sketchbook would be 18 | # ${user.home}/My Documents/Processing (make adjustments below). 19 | 20 | sketchbook.location=${user.home}/Documents/Processing 21 | 22 | 23 | 24 | # (2) 25 | # Where are the jar files located that are required for compiling your tool such 26 | # as e.g. core.jar? 27 | # By default the local classpath location points to folder libs inside Eclipse's 28 | # workspace (by default found in your home directory). 29 | # For Windows the default path would be ${user.home}/workspace/libs (make 30 | # adjustments below). 31 | 32 | #classpath.local.location=${user.home}/Documents/workspace/libs 33 | 34 | 35 | # For OSX users. 36 | # The following path will direct you into Processing's application source code 37 | # folder in case you put Processing inside your Applications folder. 38 | # Uncommenting the line below will overwrite the classpath.local.location from 39 | # above. 40 | 41 | classpath.local.location=/Applications/Processing.app/Contents/Resources/Java/lib/ 42 | 43 | 44 | # Add all jar files that are required for compiling your project to the local 45 | # and project classpath, use a comma as delimiter. These jar files must be 46 | # inside your classpath.local.location folder. 47 | # 48 | # For creating a tool, both pde.jar and core.jar are required. (pde.jar should 49 | # then be located inside folder classpath.local.location). 50 | # The best practice would be to place both, core.jar and pde.jar into your local 51 | # classpath location. 52 | 53 | classpath.local.include=core.jar,pde.jar 54 | 55 | 56 | # Add processing's libraries folder to the classpath. 57 | # If you don't need to include the libraries folder to your classpath, comment 58 | # out the following line. 59 | 60 | classpath.libraries.location=${sketchbook.location}/libraries 61 | 62 | 63 | 64 | # (3) 65 | # Set the java version that should be used to compile your tool. 66 | 67 | java.target.version=1.6 68 | 69 | 70 | # Set the description of the Ant build.xml file. 71 | 72 | ant.description=ProcessingTools Ant build file. 73 | 74 | 75 | 76 | # (4) 77 | # Project details. 78 | # Give your tool a name. The name must not contain spaces or special characters. 79 | # When creating a tool, the name of the main class which implements Tool must be 80 | # the same as the value defined for project.name in your build.properties. 81 | 82 | project.name=HelloTool 83 | 84 | # The name as the user will see it. This can contain spaces and special characters. 85 | 86 | project.prettyName=Hello Tool 87 | 88 | 89 | # Use 'normal' or 'fast' as value for project.compile. 90 | # 'fast' will only compile the project into your sketchbook. 91 | # 'normal' will compile the distribution including the javadoc-reference and all 92 | # web-files (the compile process here takes longer). 93 | 94 | project.compile=normal 95 | 96 | # All files compiled with project.compile=normal are stored 97 | # in the distribution folder. 98 | 99 | 100 | 101 | # (5) 102 | # The following items are properties that will be used to make changes to the 103 | # web document templates. Values of properties will be inserted into the 104 | # documents automatically. 105 | # If you need more control, you can edit web/index.html and web/tool.properties 106 | # directly. 107 | 108 | author.name=Your Name 109 | author.url=http://yoururl.com 110 | 111 | 112 | # Set the web page for your tool. 113 | # This is NOT a direct link to where to download it. 114 | 115 | tool.url=http://yourtoolname.com 116 | 117 | 118 | # Set the category of your tool. This must be one (or many) of the following: 119 | # "3D" "Animation" "Compilations" "Data" 120 | # "Fabrication" "Geometry" "GUI" "Hardware" 121 | # "I/O" "Language" "Math" "Simulation" 122 | # "Sound" "Utilities" "Typography" "Video & Vision" 123 | # If a value other than those listed is used, your tool will listed as "Other." 124 | 125 | tool.category=Other 126 | 127 | 128 | # A short sentence (or fragment) to summarize the tool's function. This will be 129 | # shown from inside the PDE when the tool is being installed. Avoid repeating 130 | # the name of your tool here. Also, avoid saying anything redundant like 131 | # mentioning that it's a tool. This should start with a capitalized letter, and 132 | # end with a period. 133 | 134 | tool.sentence=A collection of utilities for solving this and that problem. 135 | 136 | 137 | # Additional information suitable for the Processing website. The value of 138 | # 'sentence' always will be prepended, so you should start by writing the 139 | # second sentence here. If your tool only works on certain operating systems, 140 | # mention it here. 141 | 142 | tool.paragraph= 143 | 144 | 145 | # Set the source code repository for your project. 146 | # Recommendations for storing your source code online are Google Code or GitHub. 147 | 148 | source.host=Google Code 149 | source.url=http://code.google.com/p/yourProject 150 | source.repository=http://code.google.com/p/yourProject/source/browse/ 151 | 152 | 153 | # The current version of your tool. 154 | # This number must be parsable as an int. It increments once with each release. 155 | # This is used to compare different versions of the same tool, and check if an 156 | # update is available. 157 | 158 | tool.version=1 159 | 160 | 161 | # The version as the user will see it. 162 | 163 | tool.prettyVersion=1.0.0 164 | 165 | 166 | tool.copyright=(c) 2013 167 | tool.dependencies=? 168 | tool.keywords=? 169 | 170 | tested.platform=osx,windows 171 | tested.processingVersion=1.5 172 | 173 | 174 | # Include javadoc references into your project's javadocs. 175 | 176 | javadoc.java.href=http://java.sun.com/javase/6/docs/api/ 177 | javadoc.processing.href=http://processing.googlecode.com/svn/trunk/processing/build/javadoc/core/ 178 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | The following describes how to set up a Processing tool project in Eclipse and build it successfully, and to make your tool ready for distribution. 2 | 3 | ## Import to Eclipse 4 | 5 | There are two options to import the template project into Eclipse: using a Git [fork](https://help.github.com/articles/fork-a-repo) or using a downloaded package. If you are not familiar with Git or GitHub, you should opt for the downloaded package. 6 | 7 | ### Option A: GitHub 8 | 9 | 1. Fork the template repository to use as a starting point. 10 | * Navigate to https://github.com/processing/processing-tool-template in your browser. 11 | * Click the "Fork" button in the top-right of the page. 12 | * Once your fork is ready, open the new repository's "Settings" by clicking the link in the menu bar on the right. 13 | * Change the repository name to the name of your tool and save your changes. 14 | * NOTE: GitHub only allows you to fork a project once. If you need to create multiple forks, you can follow these [instructions](http://adrianshort.org/2011/11/08/create-multiple-forks-of-a-github-repo/). 15 | 1. Clone your new repository to your Eclipse workspace. 16 | * Open Eclipse and select the File → Import... menu item. 17 | * Select Git → Projects from Git, and click "Next >". 18 | * Select "URI" and click "Next >". 19 | * Enter your repository's clone URL in the "URI" field. The remaining fields in the "Location" and "Connection" groups will get automatically filled in. 20 | * Enter your GitHub credentials in the "Authentication" group, and click "Next >". 21 | * Select the `master` branch on the next screen, and click "Next >". 22 | * The default settings on the "Local Configuration" screen should work fine, click "Next >". 23 | * Make sure "Import existing projects" is selected, and click "Next >". 24 | * Eclipse should find and select the `processing-tool-template` automatically, click "Finish". 25 | 1. Rename your Eclipse project. 26 | * In the Package Explorer, right-click (ctrl-click) on the folder icon of the `processing-tool-template` project, and select Refactor → Rename... from the menu that pops up. 27 | * Give the project the name of your tool, and click "OK". 28 | 29 | ### Option B: Downloaded Package 30 | 31 | 1. Download the latest Eclipse template from [here](https://github.com/processing/processing-tool-template/releases). **Don't unzip the ZIP file yet.** 32 | 1. Create a new Java project in Eclipse. 33 | * From the menubar choose File → New → Java Project. 34 | * Give the project the name of your tool. 35 | * Click "Finish". 36 | 1. Import the template source files. 37 | * Right-click (ctrl-click) onto the folder icon of your newly created project in the Package Explorer and select "Import..."`" from the menu that pops up. 38 | * Select General → Archive File, and click "Next >". 39 | * Navigate to the ZIP file you downloaded earlier in step 1, and click "Finish". 40 | 41 | ## Set Up and Compile 42 | 43 | 1. Add Processing to the project build path. 44 | * Open your project's "Properties" window. 45 | * Under "Java Build Path", select the "Libraries" tab and then "Add External JARs...". 46 | * Locate and add Processing's `pde.jar` to your build path. If you're planning on using features of Processing's `PApplet` class, you'll need to add `core.jar` to the project's build path as well. It is recommended to make copies of `core.jar` and `pde.jar` in your Eclipse workspace in a `libs` folder. If this folder does not exist yet, create it. Read the [section below](#AddingJARs) regarding where to find the `core.jar` and `pde.jar` files. 47 | * Confirm the setup with "OK". 48 | 1. Edit the tool properties. 49 | * Open the `resources` folder inside of your Java project and double-click the `build.properties` file. You should see its contents in the Eclipse editor. 50 | * Edit the properties file, making changes to items 1-4 so that the values and paths are properly set for your project to compile. A path can be relative or absolute. 51 | * Make changes to items under 5. These are metadata used in the automatically generated HTML, README, and properties documents. 52 | 1. Compile your tool using Ant. 53 | * From the menu bar, choose Window → Show View → Ant. A tab with the title "Ant" will pop up on the right side of your Eclipse editor. 54 | * Drag the `resources/build.xml` file in there, and a new item "ProcessingTools" will appear. 55 | * Press the "Play" button inside the "Ant" tab. 56 | 1. BUILD SUCCESSFUL. The tool template will start to compile, control messages will appear in the console window, warnings can be ignored. When finished it should say BUILD SUCCESSFUL. Congratulations, you are set and you can start writing your own tool by making changes to the source code in folder `src`. 57 | 1. BUILD FAILED. In case the compile process fails, check the output in the console which will give you a closer idea of what went wrong. Errors may have been caused by 58 | * Incorrect path settings in the `build.properties` file. Things are most likely to go wrong at item 2, where you specify the path to `pde.jar` and other included JARs. 59 | * Error "Javadoc failed". If you are on Windows, make sure you are using a JDK instead of a JRE in order to be able to create the Javadoc for your tool. JRE does not come with the Javadoc application, but it is required to create tools from this template. 60 | 61 | After having compiled and built your project successfully, you should be able to find your tool in Processing's sketchbook folder, examples will be listed in Processing's sketchbook menu. Files that have been created for the distribution of the tool are located in your Eclipse's `workspace/yourProject/distribution` folder. In there you will also find the `web` folder which contains the documentation, a ZIP file for downloading your tool, a folder with examples as well as the `index.html` and CSS file. 62 | 63 | To distribute your tool please refer to the [Tool Guidelines](https://github.com/processing/processing/wiki/Tool-Guidelines). 64 | 65 | ## Source code 66 | 67 | If you want to share your tool's source code (and we know you do), we recommend using an online repository available for free at [Google Code](http://code.google.com) or [GitHub](http://github.com). 68 | 69 | ## Adding pde.jar and other .jar files to your classpath 70 | 71 | The `pde.jar` file contains classes responsible for creating the Processing Development Environment itself. It must be part of your classpath when building a tool. The `core.jar` file does not necessarily need to be added to your classpath, however, you will need to include it if you plan on creating any external tool windows based on `PApplet`. On Windows and Linux, these files are located in the Processing distribution folder inside a folder named "lib". On Mac OS X, right-click `Processing.app` and use `Show Package Contents` to see the guts. The `lib` folder is at `Contents` → `Resources` → `Java` → `lib`. For further information about the classes in `pde.jar`, you can see the source [here](http://code.google.com/p/processing/source/browse/trunk/processing#processing/app) and the developer documentation [here](http://processing.googlecode.com/svn/trunk/processing/build/javadoc/everything/index.html). 72 | 73 | If you created a `libs` folder as described above, put the libraries you need to add to your classpath in there. In the `Properties` of your Java project, navigate to `Java Build Path` → `Libraries`, and click `Add External JARs`. Select the `.jar` files from the `libs` folder that are required for compiling you project. Adjust the `build.properties` file accordingly. 74 | 75 | The `libs` folder is recommended but not a requirement, nevertheless you need to specify where your `jar` files are located in your system in order to add them to the classpath. 76 | 77 | In case a tool depends on systems libraries, put these dependencies next to the `jar` file. For example processing's `opengl.jar` library depends on JOGL hence the DLLs (for Windows) or jnilibs (for OS X) have to be located next to the `opengl.jar` file. 78 | 79 | ## The JDK, the JRE, Ant, & javadoc 80 | 81 | For more information about these, see the relevant sections in the [Eclipse Library Template](https://github.com/processing/processing-library-template) README. 82 | -------------------------------------------------------------------------------- /resources/code/ExampleTaglet.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright 2002 Sun Microsystems, Inc. All Rights Reserved. 3 | * 4 | * Redistribution and use in source and binary forms, with or 5 | * without modification, are permitted provided that the following 6 | * conditions are met: 7 | * 8 | * -Redistributions of source code must retain the above copyright 9 | * notice, this list of conditions and the following disclaimer. 10 | * 11 | * -Redistribution in binary form must reproduce the above copyright 12 | * notice, this list of conditions and the following disclaimer in 13 | * the documentation and/or other materials provided with the 14 | * distribution. 15 | * 16 | * Neither the name of Sun Microsystems, Inc. or the names of 17 | * contributors may be used to endorse or promote products derived 18 | * from this software without specific prior written permission. 19 | * 20 | * This software is provided "AS IS," without a warranty of any 21 | * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 22 | * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 23 | * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY 24 | * EXCLUDED. SUN AND ITS LICENSORS SHALL NOT BE LIABLE FOR ANY 25 | * DAMAGES OR LIABILITIES SUFFERED BY LICENSEE AS A RESULT OF OR 26 | * RELATING TO USE, MODIFICATION OR DISTRIBUTION OF THE SOFTWARE OR 27 | * ITS DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE 28 | * FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, 29 | * SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER 30 | * CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF 31 | * THE USE OF OR INABILITY TO USE SOFTWARE, EVEN IF SUN HAS BEEN 32 | * ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 33 | * 34 | * You acknowledge that Software is not designed, licensed or 35 | * intended for use in the design, construction, operation or 36 | * maintenance of any nuclear facility. 37 | */ 38 | 39 | import com.sun.tools.doclets.Taglet; 40 | import com.sun.javadoc.*; 41 | import java.util.Map; 42 | import java.io.*; 43 | /** 44 | * A sample Taglet representing @example. This tag can be used in any kind of 45 | * {@link com.sun.javadoc.Doc}. It is not an inline tag. The text is displayed 46 | * in yellow to remind the developer to perform a task. For 47 | * example, "@example Hello" would be shown as: 48 | *

50 | * To Do: 51 | *

Fix this! 52 | *

" + 195 | "

+Example

"+theString+"

" + 197 | "