Merge branch 'release/0.3.0' into 'master'

Release/0.3.0

See merge request Apps/bin-eLehrmittel/pdf-wrap!6

Author: Nicolas Schäfli

.idea/encodings.xml

@@ -4,6 +4,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.3.0 - 2019-06-02
+### Added
+* Forms api which can be used to place rectangles, lines, circles and ellipses
+in a document.
+* Selection tool which allows to transform existing forms and drawings.
+### Changed
+* Upgrade to typescript version ^3.4.0
+* Engines version constraint (node 10.9 < 13.0, yarn 1.13 < 2.0)
+* Migrate to Gulp 4.
+* Updated dev example
+* Migrate from uglify-js to terser in order to target es2015.
+* Only one tool can be active at once.
+* Default to highlighting mode if no tool is active.
+* **BREAKING CHANGES**
+    * The event PageEventCollection#afterRectangleRendered() has
+    been renamed to PageEventCollection#afterHighlightRendered().
+    * The Points of all elements now expect to have a x,y and z field.
+    * Target es2015.
+
 ## 0.2.0 - 2019-01-18
 
 ### Added

.idea/typescript-compiler.xml

@@ -33,9 +33,28 @@ to not install gulp globally and use the local gulp version.
 
 > local gulp can be accessed with `yarn gulp`
 
-## Running the tests
+> Run `yarn gulp --tasks` to obtain a list of all defined tasks.
 
-Run unit tests
+## Build
+### Library
+To build and package the library run the following command.
+```
+yarn gulp repackage
+```
+The packed library will be located at `build/distributions/npm`.
+
+### Documentation
+The documentation is located at `./docs`.
+In order to build the documentation run the following command.
+```
+yarn gulp mkdocs 
+```
+The html documentation will be located at `./build/docs`. 
+
+## Tests
+### Unit tests
+
+All unit test can be run with the following command.
 
 ```
 yarn gulp test
@@ -63,6 +82,7 @@ We use [SemVer](http://semver.org/) for versioning. For the versions available,
 ## Authors
 
 * **Nicolas Märchy** - *Initial work* - [BilledTrain380](https://github.com/BilledTrain380)
+* **Nicolas Schäfli** - [d3r1w](https://github.com/d3r1w)
 
 See also the list of [contributors](https://github.com/studer-raimann/pdf-wrap/graphs/contributors) who participated in this project.
 

CHANGELOG.md

@@ -306,6 +306,38 @@ The Eraser can only remove strokes made with the Freehand tool.
 In order to remove a stroke, the eraser tool needs to be activated
 and the stroke needs to be crossed with the mouse while the mouse is pressed.
 
+### Selection
+
+**Limitations:**
+* The selected element can not be moved from one page to another.
+* Multiselection is currently not supported.
+
+The selection can be used to select forms or drawings.
+
+An element selection supports the following operations:
+* Resizing
+* Repositioning
+* Color change of the element (Fill & Border)
+* Change of the drawing sequence (z axis) 
+
+### Forms
+The forms tool places form elements onto the document which may be transformed with the selection tool.
+
+Currently there are four types of forms supported:
+* Rectangles
+* Ellipse
+* Circles
+* Lines
+
+Forms can be placed with the forms tool located in the *toolbox*.
+
+```typescript
+pdf.toolbox.forms.circle.fillColor = colorFromHex("#F006");
+pdf.toolbox.forms.circle.borderColor = colorFromHex("#0F06");
+pdf.toolbox.forms.circle.create();
+pdf.toolbox.forms.circle.create(); // Will have the same colors then the first circle.
+```
+
 ## Using the highlighting
 
 **Limitations:**

README.md

@@ -6,17 +6,25 @@
   "author": "studer + raimann ag",
   "license": "GPL-3.0",
   "scripts": {
-    "copyCSS": "cp -r src/css build/www",
-    "copyPDFjs": "mkdir -p build/www/assets/libs/pdf-wrap && cp -r node_modules/@srag/pdf-wrap/assets/* build/www/assets/libs/pdf-wrap",
-    "copyResources": "cp src/index.html build/www && cp -r src/assets/* build/www/assets",
-    "build": "yarn webpack && yarn run copyResources && yarn run copyPDFjs && yarn run copyCSS",
+    "build": "yarn webpack -c webpack.config.js",
     "clean": "rm -r build",
-    "start": "yarn run build && yarn light-server -s build/www"
+    "start": "yarn webpack-dev-server -c webpack.config.js"
   },
   "devDependencies": {
-    "light-server": "^2.5.1",
+    "copy-webpack-plugin": "^5.0.3",
+    "css-loader": "^2.1.1",
+    "file-loader": "^3.0.1",
+    "html-webpack-plugin": "^3.2.0",
+    "raw-loader": "^2.0.0",
+    "style-loader": "^0.23.1",
     "webpack": "^4.12.0",
-    "webpack-cli": "^3.0.3"
+    "webpack-cli": "^3.0.3",
+    "webpack-dev-server": "^3.4.1"
   },
-  "dependencies": {}
+  "dependencies": {
+    "bootstrap": "^4.3.1",
+    "bootstrap-colorpicker": "^3.1.2",
+    "jquery": "^3.4.1",
+    "popper.js": "^1.14.7"
+  }
 }

docs/reference-documentation.md

@@ -0,0 +1,52 @@
+html, body {
+    height: 100%;
+}
+
+.pdf-container {
+    overflow: scroll;
+    height: 100%;
+    position: relative;
+}
+
+.pdf-container * {
+    box-sizing: content-box !important;
+}
+
+.middle.aligned {
+    text-align: center;
+}
+
+.sidebar {
+    background-color: white;
+    overflow-y: scroll;
+}
+
+.sidebar.left {
+    float: left;
+}
+
+.sidebar.right {
+    float: right;
+}
+
+.dark {
+    background-color: #333333;
+}
+
+.padded {
+    padding: 10px;
+}
+
+ul.no.style {
+    list-style: none;
+}
+
+li.center.aligned {
+    text-align: center;
+}
+
+.positioned-viewport {
+    top: 239px!important;
+    left: 335px!important;
+    right: 160px!important;
+}