Mercurial > gemma

annotate client/docs/developers.md @ 4348:dc5a10542e16

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
client, docs: add hints about svg2pdf shortcomings
author Bernhard Reiter <bernhard@intevation.de>
date Mon, 09 Sep 2019 12:35:25 +0200
parents 8ac59c8183e8
children 6365466ead83
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4327
b372fbe15300 client: refactor dev documentation
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
1 When developing wamos, check out
b372fbe15300 client: refactor dev documentation
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
2
b372fbe15300 client: refactor dev documentation
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
3 * [How translations are handled](dev-translations.md)
b372fbe15300 client: refactor dev documentation
Bernhard Reiter <bernhard@intevation.de>
parents:
diff changeset
4 * [Rationale of some choices](dev-generalconsiderations.md)
4329
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
5
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
6 ## Hints
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
7
4348
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
8 ### svg2pdf
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
9
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
10 https://github.com/yWorks/svg2pdf.js has known shortcomings,
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
11 which we work around.
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
12
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
13 Not all layout possibilities of webbrowser are not supported!
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
14
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
15 Our tactics is to report the problems, but work around them, if we can,
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
16 some examples:
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
17
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
18 * https://github.com/yWorks/svg2pdf.js/issues/82 (Unsupported features/Known issues)
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
19 * https://github.com/yWorks/svg2pdf.js/issues/109 (alignment-baseline attribute does not work)
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
20 * https://github.com/yWorks/svg2pdf.js/issues/100 (Font-size in `em` unit does not work)
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
21
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
22
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
23 ### Testing diagram layout and pdf export
dc5a10542e16 client, docs: add hints about svg2pdf shortcomings
Bernhard Reiter <bernhard@intevation.de>
parents: 4334
diff changeset
24
4329
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
25 When testing the vuex store object can be accessed from the
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
26 webbrowsers console like
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
27
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
28 ```javascript
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
29 store = document.getElementsByTagName('a')[0].__vue__.$store
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
30 ```
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
31
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
32 This allows for setting test values where getting real test data
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
33 is complicated. For example testing the diagramm for the
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
34 fairwayavailability (tested with Chromium 73 und gemma-2019-09-04):
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
35
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
36 ```javascript
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
37 data = store.state.fairwayavailability.csv
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
38
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
39 data=`#time,# < LDC (164.0) [h],# >= LDC (164.0) [h],# < 230.0 [h],# >= 230.0 [h],# >= 250.0 [h]
4334
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
40 01-2019,0 ,744, 0, 0,744
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
41 02-2019,324,324,150,174,324
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
42 03-2019, 24,696, 80, 45, 50
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
43 04-2019,120,600, 24, 24,672.5
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
44 05-2019,140,80 , 80, 45, 50
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
45 06-2019, 0, 0, 0, 0, 0.000
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
46 07-2019, 0,300, 0, 0, 0
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
47 08-2019, 0, 0,744, 0, 0
8ac59c8183e8 client: add showNumbers to AvailableFairwayDepth diagram
Bernhard Reiter <bernhard@intevation.de>
parents: 4329
diff changeset
48 09-2019, 0,720, 0, 96,624
4329
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
49 `
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
50
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
51 store.commit("fairwayavailability/setAvailableFairwayDepthData", data)
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
52 ```
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
53
83eb99662a91 client: improve ability to test FW diagrams
Bernhard Reiter <bernhard@intevation.de>
parents: 4327
diff changeset
54 (Depends on the code structure in store/fairwayavailability.js.)