bimplus-webclient 0.1.41 → 0.1.42-ifcjs-0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -117
- package/dist/bimplus-webclient.js +1 -2026
- package/package.json +52 -52
package/README.md
CHANGED
|
@@ -1,117 +1,117 @@
|
|
|
1
|
-
bim+ webclient
|
|
2
|
-
=========
|
|
3
|
-
|
|
4
|
-
bim+ webclient is a javascript module for integrating bimplus into custom web pages
|
|
5
|
-
|
|
6
|
-
Quick Links
|
|
7
|
-
-----------
|
|
8
|
-
|
|
9
|
-
https://doc.allplan.com/display/bimpluspublic/Bimplus+Web+SDK+Reference
|
|
10
|
-
|
|
11
|
-
How to build
|
|
12
|
-
------------
|
|
13
|
-
|
|
14
|
-
### Install nodejs
|
|
15
|
-
[http://www.nodejs.org/](http://www.nodejs.org/)
|
|
16
|
-
|
|
17
|
-
### Install local npm modules
|
|
18
|
-
Open up a normal command line (admin is not needed) and go to the webclient folder
|
|
19
|
-
|
|
20
|
-
npm install
|
|
21
|
-
|
|
22
|
-
(whenever package.json has changed, you might to do this again)
|
|
23
|
-
|
|
24
|
-
### Build webclient
|
|
25
|
-
Library building process is using UMD (Universal Module Definition) output format so
|
|
26
|
-
it's compatible with both cjs and amd module formats. The same library can be use in the
|
|
27
|
-
client or on the server. Build process is using babel so it's possible to use new ES2015
|
|
28
|
-
code in source codes.
|
|
29
|
-
|
|
30
|
-
Library can be build in several ways as a dev or prod version.
|
|
31
|
-
To run a dev build with source maps run:
|
|
32
|
-
|
|
33
|
-
npm run build
|
|
34
|
-
|
|
35
|
-
To build a prod version - uglified, minified run:
|
|
36
|
-
|
|
37
|
-
npm run build-prod
|
|
38
|
-
|
|
39
|
-
Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
|
|
40
|
-
|
|
41
|
-
npm run npm-publish
|
|
42
|
-
|
|
43
|
-
Check content of npm package (result is bimplus-webclient@(version).tar.gz)
|
|
44
|
-
|
|
45
|
-
npm run npm-pack
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
### Develop/Debug webclient
|
|
49
|
-
goto your webclient folder
|
|
50
|
-
|
|
51
|
-
npm link
|
|
52
|
-
|
|
53
|
-
goto your application folder which uses the webclient
|
|
54
|
-
|
|
55
|
-
npm link bimplus-webclient
|
|
56
|
-
|
|
57
|
-
Do you changes in the webclient and build
|
|
58
|
-
|
|
59
|
-
npm run build
|
|
60
|
-
|
|
61
|
-
or
|
|
62
|
-
|
|
63
|
-
npm run build-prod
|
|
64
|
-
|
|
65
|
-
Your app will automatically get the changes done in the renderer
|
|
66
|
-
|
|
67
|
-
After developing it might be wise to unlink:
|
|
68
|
-
goto your webclient folder
|
|
69
|
-
|
|
70
|
-
npm unlink
|
|
71
|
-
goto your application folder which uses the webclient
|
|
72
|
-
|
|
73
|
-
npm unlink bimplus-webclient
|
|
74
|
-
npm install
|
|
75
|
-
|
|
76
|
-
### Unit testing
|
|
77
|
-
To run the unit tests karma CLI is used. To get karma use
|
|
78
|
-
|
|
79
|
-
npm install
|
|
80
|
-
|
|
81
|
-
Run test in headleass mode
|
|
82
|
-
|
|
83
|
-
npm run test
|
|
84
|
-
|
|
85
|
-
The tests areperformed for all specified browsers in karma.conf.js.
|
|
86
|
-
|
|
87
|
-
### Documentation
|
|
88
|
-
Bimplus webclient uses npm documentation plugin for easy documentation generation.
|
|
89
|
-
To generate a documentation please install documentation plugin via npm :
|
|
90
|
-
|
|
91
|
-
npm install -g documentation
|
|
92
|
-
|
|
93
|
-
To create documentation in html format go to your webclient folder and run :
|
|
94
|
-
|
|
95
|
-
npm run build-doc
|
|
96
|
-
|
|
97
|
-
Documentation output will be in webclient/documentation folder
|
|
98
|
-
|
|
99
|
-
To create documentation in markdown format go to your webclient folder and run :
|
|
100
|
-
|
|
101
|
-
npm run build-docMd
|
|
102
|
-
|
|
103
|
-
Documentation output will be in webclient/documentation/Bimplus_WebSDK_doc.md file.
|
|
104
|
-
|
|
105
|
-
To create a markdown suitable for Confluence run script:
|
|
106
|
-
|
|
107
|
-
npm run build-docConf
|
|
108
|
-
|
|
109
|
-
This script will convert generated markdown into Confluence format. See console
|
|
110
|
-
output for converted file name.
|
|
111
|
-
|
|
112
|
-
Content of the confluence file can be inserted into Confluence page :
|
|
113
|
-
- start confluence page editation mode
|
|
114
|
-
- choose Insert more content / {} Markup option from toolbar
|
|
115
|
-
- in popup window choose to Insert Markdown format
|
|
116
|
-
- copy content of the converted confluence markdown file into the field in Confluence
|
|
117
|
-
- save it (Please note that page links doesn't work in page preview mode)
|
|
1
|
+
bim+ webclient
|
|
2
|
+
=========
|
|
3
|
+
|
|
4
|
+
bim+ webclient is a javascript module for integrating bimplus into custom web pages
|
|
5
|
+
|
|
6
|
+
Quick Links
|
|
7
|
+
-----------
|
|
8
|
+
|
|
9
|
+
https://doc.allplan.com/display/bimpluspublic/Bimplus+Web+SDK+Reference
|
|
10
|
+
|
|
11
|
+
How to build
|
|
12
|
+
------------
|
|
13
|
+
|
|
14
|
+
### Install nodejs
|
|
15
|
+
[http://www.nodejs.org/](http://www.nodejs.org/)
|
|
16
|
+
|
|
17
|
+
### Install local npm modules
|
|
18
|
+
Open up a normal command line (admin is not needed) and go to the webclient folder
|
|
19
|
+
|
|
20
|
+
npm install
|
|
21
|
+
|
|
22
|
+
(whenever package.json has changed, you might to do this again)
|
|
23
|
+
|
|
24
|
+
### Build webclient
|
|
25
|
+
Library building process is using UMD (Universal Module Definition) output format so
|
|
26
|
+
it's compatible with both cjs and amd module formats. The same library can be use in the
|
|
27
|
+
client or on the server. Build process is using babel so it's possible to use new ES2015
|
|
28
|
+
code in source codes.
|
|
29
|
+
|
|
30
|
+
Library can be build in several ways as a dev or prod version.
|
|
31
|
+
To run a dev build with source maps run:
|
|
32
|
+
|
|
33
|
+
npm run build
|
|
34
|
+
|
|
35
|
+
To build a prod version - uglified, minified run:
|
|
36
|
+
|
|
37
|
+
npm run build-prod
|
|
38
|
+
|
|
39
|
+
Pulish new release to npm (Hint: Before doing this npm login needs to be done and the package version adjusted) :
|
|
40
|
+
|
|
41
|
+
npm run npm-publish
|
|
42
|
+
|
|
43
|
+
Check content of npm package (result is bimplus-webclient@(version).tar.gz)
|
|
44
|
+
|
|
45
|
+
npm run npm-pack
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
### Develop/Debug webclient
|
|
49
|
+
goto your webclient folder
|
|
50
|
+
|
|
51
|
+
npm link
|
|
52
|
+
|
|
53
|
+
goto your application folder which uses the webclient
|
|
54
|
+
|
|
55
|
+
npm link bimplus-webclient
|
|
56
|
+
|
|
57
|
+
Do you changes in the webclient and build
|
|
58
|
+
|
|
59
|
+
npm run build
|
|
60
|
+
|
|
61
|
+
or
|
|
62
|
+
|
|
63
|
+
npm run build-prod
|
|
64
|
+
|
|
65
|
+
Your app will automatically get the changes done in the renderer
|
|
66
|
+
|
|
67
|
+
After developing it might be wise to unlink:
|
|
68
|
+
goto your webclient folder
|
|
69
|
+
|
|
70
|
+
npm unlink
|
|
71
|
+
goto your application folder which uses the webclient
|
|
72
|
+
|
|
73
|
+
npm unlink bimplus-webclient
|
|
74
|
+
npm install
|
|
75
|
+
|
|
76
|
+
### Unit testing
|
|
77
|
+
To run the unit tests karma CLI is used. To get karma use
|
|
78
|
+
|
|
79
|
+
npm install
|
|
80
|
+
|
|
81
|
+
Run test in headleass mode
|
|
82
|
+
|
|
83
|
+
npm run test
|
|
84
|
+
|
|
85
|
+
The tests areperformed for all specified browsers in karma.conf.js.
|
|
86
|
+
|
|
87
|
+
### Documentation
|
|
88
|
+
Bimplus webclient uses npm documentation plugin for easy documentation generation.
|
|
89
|
+
To generate a documentation please install documentation plugin via npm :
|
|
90
|
+
|
|
91
|
+
npm install -g documentation
|
|
92
|
+
|
|
93
|
+
To create documentation in html format go to your webclient folder and run :
|
|
94
|
+
|
|
95
|
+
npm run build-doc
|
|
96
|
+
|
|
97
|
+
Documentation output will be in webclient/documentation folder
|
|
98
|
+
|
|
99
|
+
To create documentation in markdown format go to your webclient folder and run :
|
|
100
|
+
|
|
101
|
+
npm run build-docMd
|
|
102
|
+
|
|
103
|
+
Documentation output will be in webclient/documentation/Bimplus_WebSDK_doc.md file.
|
|
104
|
+
|
|
105
|
+
To create a markdown suitable for Confluence run script:
|
|
106
|
+
|
|
107
|
+
npm run build-docConf
|
|
108
|
+
|
|
109
|
+
This script will convert generated markdown into Confluence format. See console
|
|
110
|
+
output for converted file name.
|
|
111
|
+
|
|
112
|
+
Content of the confluence file can be inserted into Confluence page :
|
|
113
|
+
- start confluence page editation mode
|
|
114
|
+
- choose Insert more content / {} Markup option from toolbar
|
|
115
|
+
- in popup window choose to Insert Markdown format
|
|
116
|
+
- copy content of the converted confluence markdown file into the field in Confluence
|
|
117
|
+
- save it (Please note that page links doesn't work in page preview mode)
|