Your data will be treated in accordance with our
- Privacy Policy, which sets out the rights you have in respect of your data.
+
+ Privacy Policy
+
+ , which sets out the rights you have in respect of your data.
- The guide walks you through every aspect of the BIMDataViewer in full detail.
-
-
-
-
-
-
Examples
-
🏗️
-
- A series of practical examples to help you learn how to use the BIMDataViewer.
-
-
-
-
-
-
Reference
-
📚
-
- The detailed API reference of the BIMDataViewer.
-
-
-
-
-
-
-
diff --git a/src/.vuepress/config.js b/src/.vuepress/config.js
deleted file mode 100644
index ce4ba0a..0000000
--- a/src/.vuepress/config.js
+++ /dev/null
@@ -1,29 +0,0 @@
-const sidebar = require("./sidebar.js");
-
-module.exports = {
- title: "Documentation",
- head: [["link", { rel: "icon", href: "/assets/img/favicon.svg", type: "image/svg+xml" }]],
- themeConfig: {
- logo: "/assets/img/logo.svg",
- repo: "bimdata/documentation-next",
- docsBranch: "develop",
- editLinks: true,
- docsDir: "src",
- nav: [
- { text: "API", link: "/api/introduction/overview.html" },
- { text: "Viewer", link: "/viewer/" },
- { text: "On Premises", link: "/on-premises/getting_started.html" },
- { text: "User Guide", link: "/user-guide/creer-un-compte-bimdata.html" },
- ],
- sidebar,
- searchPlaceholder: "Search",
- },
- plugins: [
- () => ({
- alias: {
- '@SearchBox':
- "/src/.vuepress/components/SearchBox.vue"
- },
- })
- ]
-};
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-api.svg b/src/.vuepress/public/assets/img/bimdata_icon-api.svg
deleted file mode 100644
index c6d26fa..0000000
--- a/src/.vuepress/public/assets/img/bimdata_icon-api.svg
+++ /dev/null
@@ -1,83 +0,0 @@
-
diff --git a/src/.vuepress/sidebar.js b/src/.vuepress/sidebar.js
deleted file mode 100644
index 00075b2..0000000
--- a/src/.vuepress/sidebar.js
+++ /dev/null
@@ -1,147 +0,0 @@
-module.exports = {
- "/api/": getApiSidebar(),
- "/plateform/": [],
- "/viewer/": getViewerSidebar(),
- "/on-premises/": getOnpremSidebar(),
- "/user-guide/": getUserGuideSidebar(),
-};
-
-function getApiSidebar() {
- return [
- {
- title: "Introduction",
- collapsable: false,
- children: ["introduction/overview", "introduction/quick_start", "introduction/concepts"],
- },
- {
- title: "Guides",
- collapsable: false,
- children: [
- "guides/application",
- "guides/authentication",
- "guides/share_data",
- "guides/scopes",
- "guides/security",
- "guides/webhooks",
- ],
- },
- "external_libraries",
- "reference",
- "viewer-reference",
- "support",
- ];
-}
-
-function getViewerSidebar() {
- return [
- "",
- {
- title: "Guide",
- children: ["guide/", "guide/plugins"],
- },
- {
- title: "Examples",
- path: "/viewer/examples/",
- children: [
- "examples/gui_layout",
- "examples/context_plugins",
- "examples/layout_manipulation",
- "examples/ifc_annotations",
- "examples/plan_annotations",
- "examples/global_components",
- "examples/partial_loading",
- ],
- },
- {
- title: "Reference",
- path: "/viewer/reference/",
- children: [
- "reference/window",
- "reference/plugin",
- "reference/makeBIMDataViewer",
- "reference/mount",
- "reference/$viewer",
- "reference/state",
- "reference/global_context",
- "reference/local_context",
- "reference/context_menu",
- "reference/keyboard_shortcuts",
- "reference/header",
- "reference/native_plugins",
- "reference/viewer_plugins",
- "reference/global_components",
- "reference/hubs",
- "reference/annotations",
- "reference/offline_mode",
- ],
- },
- "mobile",
- "viewer_sdk",
- "release_notes",
- ];
-}
-
-function getOnpremSidebar() {
- return [
- "getting_started",
- {
- title: "Installation",
- children: [
- "install/prerequisites",
- {
- title: "Quickstart",
- children: ["install/quickstart/install", "install/quickstart/config"],
- },
- "install/high_availability",
- ],
- },
- {
- title: "Configuration",
- children: [
- {
- title: "Containers environment",
- children: [
- "config/env/api",
- "config/env/connect",
- "config/env/platform_front",
- "config/env/platform_back",
- "config/env/archive",
- "config/env/workers",
- ],
- },
- ],
- },
- ];
-}
-
-function getUserGuideSidebar() {
- return [
- {
- title: "Créer un compte BIMData",
- path: "creer-un-compte-bimdata",
- },
- {
- title: "BIMData Platform",
- children: [
- "bimdata-platform/tableau-de-bord",
- "bimdata-platform/espace",
- "bimdata-platform/compte-de-facturation",
- "bimdata-platform/page-projet",
- {
- title: "GED",
- children: [
- "bimdata-platform/ged/introduction",
- "bimdata-platform/ged/navigation",
- "bimdata-platform/ged/arborescence",
- "bimdata-platform/ged/gestion-des-droits-d-acces",
- "bimdata-platform/ged/visa",
- "bimdata-platform/ged/versionning",
- "bimdata-platform/ged/fonctionnalites-avancees",
- ],
- },
- "bimdata-platform/bcf-plateforme",
- // "meta-building/meta-building",
- ],
- },
- ];
-}
diff --git a/src/.vuepress/styles/index.styl b/src/.vuepress/styles/index.styl
deleted file mode 100644
index bccb224..0000000
--- a/src/.vuepress/styles/index.styl
+++ /dev/null
@@ -1,4 +0,0 @@
-button:focus {
- outline: none;
- box-shadow: none;
-}
\ No newline at end of file
diff --git a/src/.vuepress/styles/palette.styl b/src/.vuepress/styles/palette.styl
deleted file mode 100644
index 5501b9b..0000000
--- a/src/.vuepress/styles/palette.styl
+++ /dev/null
@@ -1,3 +0,0 @@
-$accentColor = #466582
-$textColor = #2f374a
-$contentWidth = 1200px
\ No newline at end of file
diff --git a/src/api/guides/authentication.md b/src/api/guides/authentication.md
index 658a4b2..204fd27 100644
--- a/src/api/guides/authentication.md
+++ b/src/api/guides/authentication.md
@@ -24,7 +24,7 @@ curl --request POST 'https://api.bimdata.io/cloud' \
--data '{"name": "My First Cloud"}'
```
- ✅ Pros : Can be directly used without additionnal HTTP request
-- ❌ Cons : Does't have an expire date. If you leak it, the only way to secure your data is to revoke the ApiKey on the [application management page](https://connect.bimdata.io/developers/client/).
+- ❌ Cons : Doesn't have an expire date. If you leak it, the only way to secure your data is to revoke the ApiKey on the [application management page](https://connect.bimdata.io/developers/client/).
## I want to run BIMData Viewer on my website
@@ -45,7 +45,6 @@ The requests takes two parameters:
To open the viewer, `model:read` is the minimum scope required.
-
## I want to impersonate users
OpenID Connect allows you to impersonate users with your app. These flows are complex and already well documented all around Internet.
@@ -53,4 +52,4 @@ OpenID Connect allows you to impersonate users with your app. These flows are co
## I have another use case
-There are many possibilities, please contact us by email: [](support@bimdata.io)
+There are many possibilities, please contact us: support@bimdata.io
diff --git a/src/api/guides/security.md b/src/api/guides/security.md
index 4de55af..b9dc818 100644
--- a/src/api/guides/security.md
+++ b/src/api/guides/security.md
@@ -10,4 +10,4 @@ Your data are saved on a daily basis.
## HTTPS
BIMData’s HTTPS implementation is graded A+ on SSL Labs website.
-
+
diff --git a/src/api/guides/share_data.md b/src/api/guides/share_data.md
index 161c4f6..3285464 100644
--- a/src/api/guides/share_data.md
+++ b/src/api/guides/share_data.md
@@ -1,7 +1,7 @@
-# Access Data between API and Platform
+# Access Data between App and Platform
Your application don't automatically have access to your user's data.
-If you want to see API data on the BIMData Platform, you must invite yourself on a cloud created with your app.
+If you want to see your app data on the BIMData Platform, you must invite yourself on a cloud created with your app.
## How can I share data between my app and BIMData Platform?
diff --git a/src/api/introduction/concepts.md b/src/api/introduction/concepts.md
index d9f21c7..f9e5a54 100644
--- a/src/api/introduction/concepts.md
+++ b/src/api/introduction/concepts.md
@@ -6,7 +6,7 @@ A cloud is a set of projects sharing the same configuration. Each projects conta
On BIMData Platform, cloud have been renamed "Space". For compatibility reasons, we did not rename every route on the API. Cloud and Spaces are two names for the same entity.
-
+
## Project
@@ -25,7 +25,7 @@ A BCF is linked to a Project, not a Model.
A project member can see all other members, and an admin member can manage the users of the project.
-
+
## IFC
@@ -41,7 +41,7 @@ Depending on the options you chose, you can:
- Retrieve classifications, systems and zones.
- Retrieve 2D plans in SVG format.
-
+
### Upload an IFC
@@ -72,7 +72,7 @@ You can follow the progress on the `status` field:
The API exposes a complete set of methods to upload and manage documents.
-
+
### Folders
@@ -108,10 +108,9 @@ BIMData API allows you to upload any kind of file (IFC, Office, images, binaries
File upload is one of the few API calls which does not use the `application/json` Content Type. This call uses `x-www-urlencoded` with `form-data`. The name of the file field must be `“file”`, this means that you have to fire multiple calls if you want to upload many files.
-
-
+::: code-group
-```bash
+```bash [cURL]
curl -X POST \
'https://api.bimdata.io/cloud/1/project/1/document' \
-H 'authorization: Bearer ZeZr9oYxHspA8OdSCo9uftaLaEHX1N' \
@@ -120,10 +119,7 @@ curl -X POST \
-F file=@/path/to/XXX.pdf
```
-
-
-
-```python
+```python [python]
import requests
url = "https://api.bimdata.io/cloud/1/project/1/document"
@@ -143,10 +139,7 @@ response = requests.request("POST", url, data=payload, files=files, headers=head
print(response.text)
```
-
-
-
-```javascript
+```javascript [javascript]
var fs = require("fs");
var request = require("request");
@@ -173,9 +166,7 @@ request(options, function(error, response, body) {
console.log(body);
});
```
-
-
-
+:::
Response example :
@@ -205,19 +196,15 @@ The filesize is the compressed size and not the actual size of the initial file
You can download files using the URL returned by the API. The URL is valid for 1 hour.
-
-
+::: code-group
-```bash
+```bash [cURL]
curl -X GET \
'https://storage.gra3.cloud.ovh.net/v1/AUTH_b6a1c0b6b7c041d3a71d56f84ce25102/bimdata-staging-dev/cloud_1/project_1/XXX.pdf?temp_url_sig=311d34059bbebc87cd7f37de244bb6b62d114679&temp_url_expires=1527771256'
```
-
-
-
-```python
+```python [python]
import requests
url = "https://api.bimdata.io/cloud/1/project/1/ifc"
@@ -227,17 +214,14 @@ querystring = {"status":"C"}
headers = {
'Content-Type': "application/json",
'Authorization': "Bearer ZeZr9oYxHspA8OdSCo9uftaLaEHX1N",
- }
+}
response = requests.request("GET", url, headers=headers, params=querystring)
print(response.text)
```
-
-
-
-```javascript
+```javascript [javascript]
const url =
"https://storage.gra3.cloud.ovh.net/v1/AUTH_b6a1c0b6b7c041d3a71d56f84ce25102/bimdata-staging-dev/cloud_1/project_1/XXX.pdf?temp_url_sig=311d34059bbebc87cd7f37de244bb6b62d114679&temp_url_expires=1527771256";
@@ -245,9 +229,7 @@ const response = await fetch(url);
console.log(await response.text());
```
-
-
-
+:::
## User
diff --git a/src/api/introduction/overview.md b/src/api/introduction/overview.md
index db4b149..76b611c 100755
--- a/src/api/introduction/overview.md
+++ b/src/api/introduction/overview.md
@@ -7,7 +7,7 @@ BIMData API is a tool to interact with your models stored on BIMData’s servers
- Upload IFC, DWG, PDF, plan images
- Request data from clouds, projects, and models
-
+
## APIs
diff --git a/src/api/reference.md b/src/api/reference.md
index f1ea40f..472e3da 100644
--- a/src/api/reference.md
+++ b/src/api/reference.md
@@ -1,5 +1,9 @@
# Reference
+
+
diff --git a/src/api/support.md b/src/api/support.md
index 7849318..63fc610 100644
--- a/src/api/support.md
+++ b/src/api/support.md
@@ -2,4 +2,4 @@
## Where do I go if I have more questions?
-Please contact us by email: [](support@bimdata.io)
\ No newline at end of file
+Please contact us by email: support@bimdata.io
\ No newline at end of file
diff --git a/src/api/viewer-reference.md b/src/api/viewer-reference.md
index 25336b6..c9dfde6 100644
--- a/src/api/viewer-reference.md
+++ b/src/api/viewer-reference.md
@@ -1,5 +1,9 @@
# Viewer Reference
+
+
diff --git a/src/.vuepress/public/assets/img/api/API-BIMdata_connect.jpg b/src/images/api/API-BIMdata_connect.jpg
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-BIMdata_connect.jpg
rename to src/images/api/API-BIMdata_connect.jpg
diff --git a/src/.vuepress/public/assets/img/api/API-auth_flow.jpg b/src/images/api/API-auth_flow.jpg
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-auth_flow.jpg
rename to src/images/api/API-auth_flow.jpg
diff --git a/src/.vuepress/public/assets/img/api/API-cloud.png b/src/images/api/API-cloud.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-cloud.png
rename to src/images/api/API-cloud.png
diff --git a/src/.vuepress/public/assets/img/api/API-features.png b/src/images/api/API-features.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-features.png
rename to src/images/api/API-features.png
diff --git a/src/.vuepress/public/assets/img/api/API-folder&document.png b/src/images/api/API-folder&document.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-folder&document.png
rename to src/images/api/API-folder&document.png
diff --git a/src/.vuepress/public/assets/img/api/API-ifc.png b/src/images/api/API-ifc.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-ifc.png
rename to src/images/api/API-ifc.png
diff --git a/src/.vuepress/public/assets/img/api/API-organisation.png b/src/images/api/API-organisation.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-organisation.png
rename to src/images/api/API-organisation.png
diff --git a/src/.vuepress/public/assets/img/api/API-project.png b/src/images/api/API-project.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-project.png
rename to src/images/api/API-project.png
diff --git a/src/.vuepress/public/assets/img/api/API-ssl-report.png b/src/images/api/API-ssl-report.png
similarity index 100%
rename from src/.vuepress/public/assets/img/api/API-ssl-report.png
rename to src/images/api/API-ssl-report.png
diff --git a/src/.vuepress/public/assets/img/favicon.svg b/src/images/favicon.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/favicon.svg
rename to src/images/favicon.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-api.png b/src/images/home/bimdata_icon-api.png
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-api.png
rename to src/images/home/bimdata_icon-api.png
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-bcf.svg b/src/images/home/bimdata_icon-bcf.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-bcf.svg
rename to src/images/home/bimdata_icon-bcf.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-ifc.svg b/src/images/home/bimdata_icon-ifc.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-ifc.svg
rename to src/images/home/bimdata_icon-ifc.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-on_premises.png b/src/images/home/bimdata_icon-on_premises.png
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-on_premises.png
rename to src/images/home/bimdata_icon-on_premises.png
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-open_source.svg b/src/images/home/bimdata_icon-open_source.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-open_source.svg
rename to src/images/home/bimdata_icon-open_source.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-plugins.svg b/src/images/home/bimdata_icon-plugins.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-plugins.svg
rename to src/images/home/bimdata_icon-plugins.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-sdk.svg b/src/images/home/bimdata_icon-sdk.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-sdk.svg
rename to src/images/home/bimdata_icon-sdk.svg
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-user_guide.png b/src/images/home/bimdata_icon-user_guide.png
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-user_guide.png
rename to src/images/home/bimdata_icon-user_guide.png
diff --git a/src/.vuepress/public/assets/img/bimdata_icon-viewer.png b/src/images/home/bimdata_icon-viewer.png
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_icon-viewer.png
rename to src/images/home/bimdata_icon-viewer.png
diff --git a/src/.vuepress/public/assets/img/bimdata_img-ds.png b/src/images/home/bimdata_img-ds.png
similarity index 100%
rename from src/.vuepress/public/assets/img/bimdata_img-ds.png
rename to src/images/home/bimdata_img-ds.png
diff --git a/src/.vuepress/public/assets/img/design-system_logo.png b/src/images/home/design-system_logo.png
similarity index 100%
rename from src/.vuepress/public/assets/img/design-system_logo.png
rename to src/images/home/design-system_logo.png
diff --git a/src/.vuepress/public/assets/img/logo.svg b/src/images/logo.svg
similarity index 100%
rename from src/.vuepress/public/assets/img/logo.svg
rename to src/images/logo.svg
diff --git a/src/.vuepress/public/assets/img/on-premises/Onpremise-network_flow.png b/src/images/on-premises/Onpremise-network_flow.png
similarity index 100%
rename from src/.vuepress/public/assets/img/on-premises/Onpremise-network_flow.png
rename to src/images/on-premises/Onpremise-network_flow.png
diff --git a/src/.vuepress/public/assets/img/user-guide/ajouter-version.png b/src/images/user-guide/ajouter-version.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/ajouter-version.png
rename to src/images/user-guide/ajouter-version.png
diff --git a/src/.vuepress/public/assets/img/user-guide/arborescence.png b/src/images/user-guide/arborescence.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/arborescence.png
rename to src/images/user-guide/arborescence.png
diff --git a/src/.vuepress/public/assets/img/user-guide/compte-de-facturation.png b/src/images/user-guide/compte-de-facturation.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/compte-de-facturation.png
rename to src/images/user-guide/compte-de-facturation.png
diff --git a/src/.vuepress/public/assets/img/user-guide/consulter-version.png b/src/images/user-guide/consulter-version.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/consulter-version.png
rename to src/images/user-guide/consulter-version.png
diff --git a/src/.vuepress/public/assets/img/user-guide/creation-bcf.png b/src/images/user-guide/creation-bcf.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/creation-bcf.png
rename to src/images/user-guide/creation-bcf.png
diff --git a/src/.vuepress/public/assets/img/user-guide/dashboard.png b/src/images/user-guide/dashboard.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/dashboard.png
rename to src/images/user-guide/dashboard.png
diff --git a/src/.vuepress/public/assets/img/user-guide/demo.png b/src/images/user-guide/demo.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/demo.png
rename to src/images/user-guide/demo.png
diff --git a/src/.vuepress/public/assets/img/user-guide/detail-visa.png b/src/images/user-guide/detail-visa.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/detail-visa.png
rename to src/images/user-guide/detail-visa.png
diff --git a/src/.vuepress/public/assets/img/user-guide/factures.png b/src/images/user-guide/factures.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/factures.png
rename to src/images/user-guide/factures.png
diff --git a/src/.vuepress/public/assets/img/user-guide/formulaire-visa.png b/src/images/user-guide/formulaire-visa.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/formulaire-visa.png
rename to src/images/user-guide/formulaire-visa.png
diff --git a/src/.vuepress/public/assets/img/user-guide/formulaire.png b/src/images/user-guide/formulaire.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/formulaire.png
rename to src/images/user-guide/formulaire.png
diff --git a/src/.vuepress/public/assets/img/user-guide/ged-2.png b/src/images/user-guide/ged-2.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/ged-2.png
rename to src/images/user-guide/ged-2.png
diff --git a/src/.vuepress/public/assets/img/user-guide/ged.png b/src/images/user-guide/ged.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/ged.png
rename to src/images/user-guide/ged.png
diff --git a/src/.vuepress/public/assets/img/user-guide/gestion-des-droits.png b/src/images/user-guide/gestion-des-droits.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/gestion-des-droits.png
rename to src/images/user-guide/gestion-des-droits.png
diff --git a/src/.vuepress/public/assets/img/user-guide/groupes.png b/src/images/user-guide/groupes.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/groupes.png
rename to src/images/user-guide/groupes.png
diff --git a/src/.vuepress/public/assets/img/user-guide/importer-dossier.png b/src/images/user-guide/importer-dossier.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/importer-dossier.png
rename to src/images/user-guide/importer-dossier.png
diff --git a/src/.vuepress/public/assets/img/user-guide/importer-ged.png b/src/images/user-guide/importer-ged.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/importer-ged.png
rename to src/images/user-guide/importer-ged.png
diff --git a/src/.vuepress/public/assets/img/user-guide/importer-groupes.png b/src/images/user-guide/importer-groupes.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/importer-groupes.png
rename to src/images/user-guide/importer-groupes.png
diff --git a/src/.vuepress/public/assets/img/user-guide/invitation.png b/src/images/user-guide/invitation.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/invitation.png
rename to src/images/user-guide/invitation.png
diff --git a/src/.vuepress/public/assets/img/user-guide/maptiler.png b/src/images/user-guide/maptiler.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/maptiler.png
rename to src/images/user-guide/maptiler.png
diff --git a/src/.vuepress/public/assets/img/user-guide/menu-version.png b/src/images/user-guide/menu-version.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/menu-version.png
rename to src/images/user-guide/menu-version.png
diff --git a/src/.vuepress/public/assets/img/user-guide/model-manager.png b/src/images/user-guide/model-manager.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/model-manager.png
rename to src/images/user-guide/model-manager.png
diff --git a/src/.vuepress/public/assets/img/user-guide/navigation-projet.png b/src/images/user-guide/navigation-projet.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/navigation-projet.png
rename to src/images/user-guide/navigation-projet.png
diff --git a/src/.vuepress/public/assets/img/user-guide/onglet-ged.png b/src/images/user-guide/onglet-ged.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/onglet-ged.png
rename to src/images/user-guide/onglet-ged.png
diff --git a/src/.vuepress/public/assets/img/user-guide/parametres-bcf.png b/src/images/user-guide/parametres-bcf.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/parametres-bcf.png
rename to src/images/user-guide/parametres-bcf.png
diff --git a/src/.vuepress/public/assets/img/user-guide/parametres-defaut.png b/src/images/user-guide/parametres-defaut.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/parametres-defaut.png
rename to src/images/user-guide/parametres-defaut.png
diff --git a/src/.vuepress/public/assets/img/user-guide/personnalisation-parametres.png b/src/images/user-guide/personnalisation-parametres.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/personnalisation-parametres.png
rename to src/images/user-guide/personnalisation-parametres.png
diff --git a/src/.vuepress/public/assets/img/user-guide/preview.png b/src/images/user-guide/preview.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/preview.png
rename to src/images/user-guide/preview.png
diff --git a/src/.vuepress/public/assets/img/user-guide/projet.png b/src/images/user-guide/projet.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/projet.png
rename to src/images/user-guide/projet.png
diff --git a/src/.vuepress/public/assets/img/user-guide/rapport-annotation.png b/src/images/user-guide/rapport-annotation.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/rapport-annotation.png
rename to src/images/user-guide/rapport-annotation.png
diff --git a/src/.vuepress/public/assets/img/user-guide/upload-model-manager.png b/src/images/user-guide/upload-model-manager.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/upload-model-manager.png
rename to src/images/user-guide/upload-model-manager.png
diff --git a/src/.vuepress/public/assets/img/user-guide/upload-model.png b/src/images/user-guide/upload-model.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/upload-model.png
rename to src/images/user-guide/upload-model.png
diff --git a/src/.vuepress/public/assets/img/user-guide/user-espace.png b/src/images/user-guide/user-espace.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/user-espace.png
rename to src/images/user-guide/user-espace.png
diff --git a/src/.vuepress/public/assets/img/user-guide/visa-menu.png b/src/images/user-guide/visa-menu.png
similarity index 100%
rename from src/.vuepress/public/assets/img/user-guide/visa-menu.png
rename to src/images/user-guide/visa-menu.png
diff --git a/src/.vuepress/public/assets/img/viewer/complex-layout.png b/src/images/viewer/complex-layout.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/complex-layout.png
rename to src/images/viewer/complex-layout.png
diff --git a/src/.vuepress/public/assets/img/viewer/layout-with-window-names.png b/src/images/viewer/layout-with-window-names.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/layout-with-window-names.png
rename to src/images/viewer/layout-with-window-names.png
diff --git a/src/.vuepress/public/assets/img/viewer/sdk-landing.jpg b/src/images/viewer/sdk-landing.jpg
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/sdk-landing.jpg
rename to src/images/viewer/sdk-landing.jpg
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-async_plugin.gif b/src/images/viewer/viewer-async_plugin.gif
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-async_plugin.gif
rename to src/images/viewer/viewer-async_plugin.gif
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-global_context.gif b/src/images/viewer/viewer-global_context.gif
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-global_context.gif
rename to src/images/viewer/viewer-global_context.gif
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-context-menu.png b/src/images/viewer/viewer-gui-context-menu.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-context-menu.png
rename to src/images/viewer/viewer-gui-context-menu.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-header-and-windows.png b/src/images/viewer/viewer-gui-header-and-windows.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-header-and-windows.png
rename to src/images/viewer/viewer-gui-header-and-windows.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-layouts.png b/src/images/viewer/viewer-gui-layouts.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-layouts.png
rename to src/images/viewer/viewer-gui-layouts.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-free.png b/src/images/viewer/viewer-gui-plugin-button-free.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-free.png
rename to src/images/viewer/viewer-gui-plugin-button-free.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-panel.png b/src/images/viewer/viewer-gui-plugin-button-panel.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-panel.png
rename to src/images/viewer/viewer-gui-plugin-button-panel.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-simple.png b/src/images/viewer/viewer-gui-plugin-button-simple.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-button-simple.png
rename to src/images/viewer/viewer-gui-plugin-button-simple.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-default.png b/src/images/viewer/viewer-gui-plugin-default.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-gui-plugin-default.png
rename to src/images/viewer/viewer-gui-plugin-default.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-local_context.gif b/src/images/viewer/viewer-local_context.gif
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-local_context.gif
rename to src/images/viewer/viewer-local_context.gif
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-mobile-plan.png b/src/images/viewer/viewer-mobile-plan.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-mobile-plan.png
rename to src/images/viewer/viewer-mobile-plan.png
diff --git a/src/.vuepress/public/assets/img/viewer/viewer-mobile.png b/src/images/viewer/viewer-mobile.png
similarity index 100%
rename from src/.vuepress/public/assets/img/viewer/viewer-mobile.png
rename to src/images/viewer/viewer-mobile.png
diff --git a/src/index.md b/src/index.md
index c859b7d..ac9c9c0 100755
--- a/src/index.md
+++ b/src/index.md
@@ -1,3 +1,9 @@
---
-layout: Home
----
\ No newline at end of file
+layout: home
+---
+
+
+
+
diff --git a/src/on-premises/config/env/api.md b/src/on-premises/config/env/api.md
index 5c0ba44..be067b6 100644
--- a/src/on-premises/config/env/api.md
+++ b/src/on-premises/config/env/api.md
@@ -1,11 +1,11 @@
-# Bimdata API
+# BIMData API
-## URLs of Bimdata apps
+## URLs of BIMData apps
| Variables | Default value | Description |
|-------------|---------------|----------------------------|
-| API_URL | "" | Bimdata API URL. |
-| CONNECT_URL | "" | Bimdata Connect URL. |
-| DOC_URL | "" | Bimdata Documentation URL. |
+| API_URL | "" | BIMData API URL. |
+| CONNECT_URL | "" | BIMData Connect URL. |
+| DOC_URL | "" | BIMData Documentation URL. |
## Database configuration
There variables are needed for the database authentication.
diff --git a/src/on-premises/config/env/archive.md b/src/on-premises/config/env/archive.md
index 19d426a..fcdda1c 100644
--- a/src/on-premises/config/env/archive.md
+++ b/src/on-premises/config/env/archive.md
@@ -1,9 +1,9 @@
-# Bimdata Archive
+# BIMData Archive
-## URLs of Bimdata apps
+## URLs of BIMData apps
| Variables | Default value | Description |
|-------------|---------------|-------------------------|
-| API_URL | "" | Bimdata API URL. |
+| API_URL | "" | BIMData API URL. |
## Image configuration
| Variables | Default value | Description |
diff --git a/src/on-premises/config/env/connect.md b/src/on-premises/config/env/connect.md
index b82b0b1..73a31e4 100644
--- a/src/on-premises/config/env/connect.md
+++ b/src/on-premises/config/env/connect.md
@@ -1,13 +1,13 @@
-# Bimdata Connect
+# BIMData Connect
-## URLs of Bimdata apps
+## URLs of BIMData apps
| Variables | Default value | Description |
|--------------|---------------|----------------------------|
-| SITE_URL | "" | Bimdata Connect URL. |
-| API_URL | "" | Bimdata API URL. |
-| DOC_URL | "" | Bimdata Documentation URL. |
-| PLATFORM_URL | "" | Bimdata Platform URL. |
+| SITE_URL | "" | BIMData Connect URL. |
+| API_URL | "" | BIMData API URL. |
+| DOC_URL | "" | BIMData Documentation URL. |
+| PLATFORM_URL | "" | BIMData Platform URL. |
## Database configuration
There variables are needed for the database authentication.
diff --git a/src/on-premises/config/env/platform_back.md b/src/on-premises/config/env/platform_back.md
index 674e3b4..1817915 100644
--- a/src/on-premises/config/env/platform_back.md
+++ b/src/on-premises/config/env/platform_back.md
@@ -1,12 +1,12 @@
-# Bimdata Platform Back
+# BIMData Platform Back
-## URLs of Bimdata apps
+## URLs of BIMData apps
| Variables | Default value | Description |
|-------------------|----------------|-----------------------------|
-| API_URL | "" | Bimdata API URL. |
-| PLATFORM_URL | "" | Bimdata platform front URL. |
-| PLATFORM_BACK_URL | "" | Bimdata platform back URL. |
+| API_URL | "" | BIMData API URL. |
+| PLATFORM_URL | "" | BIMData platform front URL. |
+| PLATFORM_BACK_URL | "" | BIMData platform back URL. |
## Database configuration
There variables are needed for the database authentication.
diff --git a/src/on-premises/config/env/platform_front.md b/src/on-premises/config/env/platform_front.md
index c4c6ca8..f8d1ca8 100644
--- a/src/on-premises/config/env/platform_front.md
+++ b/src/on-premises/config/env/platform_front.md
@@ -1,17 +1,17 @@
-# Bimdata Platform Front
+# BIMData Platform Front
-## URLs of Bimdata apps
+## URLs of BIMData apps
| Variables | Default value | Description |
|----------------------------|---------------|-----------------------------|
-| VUE_APP_BASE_URL | | Bimdata Platform front URL. |
-| VUE_APP_BACKEND_BASE_URL | | Bimdata Platform back URL. |
-| VUE_APP_API_BASE_URL | | Bimdata API URL. |
-| VUE_APP_ARCHIVE_BASE_URL | | Bimdata Archive URL. |
-| VUE_APP_URL_BIMDATACONNECT | | Bimdata Connect URL. |
-| VUE_APP_URL_DOCUMENTATION | | Bimdata documentation URL. |
-| VUE_APP_URL_MARKETPLACE | | Bimdata marketplace URL. |
-| VUE_APP_URL_OLD_PLATFORM | | Bimdata old platform URL. |
+| VUE_APP_BASE_URL | | BIMData Platform front URL. |
+| VUE_APP_BACKEND_BASE_URL | | BIMData Platform back URL. |
+| VUE_APP_API_BASE_URL | | BIMData API URL. |
+| VUE_APP_ARCHIVE_BASE_URL | | BIMData Archive URL. |
+| VUE_APP_URL_BIMDATACONNECT | | BIMData Connect URL. |
+| VUE_APP_URL_DOCUMENTATION | | BIMData documentation URL. |
+| VUE_APP_URL_MARKETPLACE | | BIMData marketplace URL. |
+| VUE_APP_URL_OLD_PLATFORM | | BIMData old platform URL. |
## OpenID configuration
| Variables | Default value | Description |
diff --git a/src/on-premises/config/env/workers.md b/src/on-premises/config/env/workers.md
index 28a6b83..155212a 100644
--- a/src/on-premises/config/env/workers.md
+++ b/src/on-premises/config/env/workers.md
@@ -1,10 +1,10 @@
-# Bimdata workers
+# BIMData workers
## Workers
-### URLs of Bimdata apps
+### URLs of BIMData apps
| Variables | Default value | Description |
|-------------|-------------------------|-------------------------|
-| API_URL | "http://0.0.0.0:8000" | Bimdata API URL. |
+| API_URL | "http://0.0.0.0:8000" | BIMData API URL. |
### RabbitMQ configuration
| Variables | Default value | Description |
@@ -33,10 +33,10 @@
| ENV | "development" | |
## Workers xkt
-### URLs of Bimdata apps
+### URLs of BIMData apps
| Variables | Default value | Description |
|-------------|----------------------------------|-------------------------|
-| API_URL | "https://api-staging.bimdata.io" | Bimdata API URL. |
+| API_URL | "https://api-staging.bimdata.io" | BIMData API URL. |
### RabbitMQ configuration
| Variables | Default value | Description |
@@ -47,10 +47,10 @@
| RABBITMQ_PASSWORD | "guest" | RabbitMQ password. |
## Worker headless viewer 360
-### URLs of Bimdata apps
+### URLs of BIMData apps
| Variables | Default value | Description |
|-------------|----------------------------------|-------------------------|
-| API_URL | "https://api-staging.bimdata.io" | Bimdata API URL. |
+| API_URL | "https://api-staging.bimdata.io" | BIMData API URL. |
### RabbitMQ configuration
| Variables | Default value | Description |
diff --git a/src/on-premises/getting_started.md b/src/on-premises/getting_started.md
index e629c24..7328a45 100644
--- a/src/on-premises/getting_started.md
+++ b/src/on-premises/getting_started.md
@@ -4,25 +4,25 @@ This document explains how to install BIMData.io applications on your servers.
You can test our products on our [SaaS Platform](https://platform.bimdata.io).
## How to have access to on-premises
-You must contact our [sales services](contact@bimdata.io) to have access to the necessary resources for the installation.
+You must contact our [sales services](mailto:contact@bimdata.io) to have access to the necessary resources for the installation.
## Architecture
The BIMData.io softwares are separated into multiple components, each one with its role.
### Web applications
Web applications are the components with which the users interact:
- - **Bimdata Connect**: manage users and authentication,
- - **Bimdata API**: to interact with the data,
- - **Bimdata Platform**: allow the use of the previous components in our ergonomic interface.
+ - **BIMData Connect**: manage users and authentication,
+ - **BIMData API**: to interact with the data,
+ - **BIMData Platform**: allow the use of the previous components in our ergonomic interface.
The plaform is split in two components:
- **Platform_front**
- **Platform_back**
- - **Bimdata Marketplace**: to manage differents plugins.
+ - **BIMData Marketplace**: to manage differents plugins.
The Marketplace is split in two components:
- **Marketplace_front**
- **Marketplace_back**
- - **Bimdata Archive**: to download zip archives from the DMS.
- - **Bimdata Documentation**: a copy of our documentation, in the right version, so you can always access it.
+ - **BIMData Archive**: to download zip archives from the DMS.
+ - **BIMData Documentation**: a copy of our documentation, in the right version, so you can always access it.
### Workers
Workers are the components that will be used to extract, transform, convert or produce
@@ -36,7 +36,7 @@ data from models or other documents. There are a lot of different workers:
- Merge:
### Third-party components
-Bimdata.io softwares need other components to work:
+BIMData.io softwares need other components to work:
- [Keycloak](https://www.keycloak.org/): an open-source identify and access management solution used for the authentication,
- [Postgresql](https://www.postgresql.org/): an open-source relational database used to store structured data; Used by all BIMData.io backends and keycloak,
- [RabbitMQ](https://www.rabbitmq.com): an open-source message broker used for asynchronous communications between our components. Used by Workers.
@@ -48,4 +48,4 @@ They can also use some optional components:
There are a lot of different components, it can be complicated to understand their interactions,
so we hope this diagram can help you to apprehend the different network flows:
-
+
diff --git a/src/on-premises/install/high_availability.md b/src/on-premises/install/high_availability.md
index 9cf3f7b..2433c19 100644
--- a/src/on-premises/install/high_availability.md
+++ b/src/on-premises/install/high_availability.md
@@ -1,5 +1,5 @@
# High availability
-Most of Bimdata's components are stateless, so we can simply increase the
+Most of BIMData's components are stateless, so we can simply increase the
number of replicas and run them across multiple nodes and use the leverage of
the internal mechanism of the orchestrator to distribute the charge across them.
@@ -10,14 +10,14 @@ This include :
- a highly available RabbitMQ cluster,
- a highly available Keycloak cluser.
-## Bimdata API
-Bimdata API itself is stateless, but it manages the storage of uploaded data by users.
+## BIMData API
+BIMData API itself is stateless, but it manages the storage of uploaded data by users.
Therefore, you have two possibilities:
- use a redundant swift object storage to store the data,
- you need to provide a redundant storage shared between all the API containers.
-## Bimdata Connect
-Bimdata Connect itself is stateless, but it manages the storage of uploaded data by users.
+## BIMData Connect
+BIMData Connect itself is stateless, but it manages the storage of uploaded data by users.
Therefore, you have two possibilities:
- use a redundant swift object storage to store the data,
- you need to provide a redundant storage shared between all the Connect containers.
diff --git a/src/on-premises/install/quickstart/install.md b/src/on-premises/install/quickstart/install.md
index 2094545..b4f86ac 100644
--- a/src/on-premises/install/quickstart/install.md
+++ b/src/on-premises/install/quickstart/install.md
@@ -21,14 +21,14 @@ You may need to modify it to suit your needs.
- You must be sudo / root on the servers.
## Environment
-This quickstart uses Ansible to install Docker, Docker-compose, and the Bimdata
+This quickstart uses Ansible to install Docker, Docker-compose, and the BIMData
applications on the configured servers.
This doesn't support HA deployment currently.
## How to start
### The easy way
We provide a script to simplify the Ansible usage. Keep in mind that it will not let
-you completely personalize how you want to install the Bimdata.io apps.
+you completely personalize how you want to install the BIMData.io apps.
Clone the repository:
```
diff --git a/src/user-guide/bimdata-platform/bcf-plateforme.md b/src/user-guide/bimdata-platform/bcf-plateforme.md
index 982fec5..745acb1 100644
--- a/src/user-guide/bimdata-platform/bcf-plateforme.md
+++ b/src/user-guide/bimdata-platform/bcf-plateforme.md
@@ -4,7 +4,7 @@
Le tableau de bord des BCF de la plateforme BIMData facilite la gestion complète des commentaires BCF de votre projet. Il permet d’ouvrir, de gérer et de télécharger les commentaires, offrant ainsi un suivi centralisé et efficace des échanges pour une meilleure collaboration entre les parties prenantes.
-
+
## Importer vos fichiers BCF
@@ -18,7 +18,7 @@ Une fois le fichier importé, les annotations et commentaires contenus dans celu
La création d’un commentaire BCF sur la plateforme BIMData est simple et rapide grâce à un formulaire dédié.
-
+
Dans le tableau de bord des BCF, cliquez sur le bouton **"Créer un BCF"**, situé en haut à droite de l'interface.
* Un formulaire s’affiche, vous permettant de saisir les informations nécessaires pour créer votre commentaire.
@@ -30,7 +30,7 @@ Dans le tableau de bord des BCF, cliquez sur le bouton **"Créer un BCF"**, situ
La plateforme BIMData offre des **paramètres personnalisables** pour optimiser la gestion des annotations BCF et s’adapter aux besoins spécifiques de votre projet.
-
+
Pour accéder à ces derniers, cliquez sur la roue dentée à gauche du bouton "Importer".
@@ -43,7 +43,7 @@ La plateforme BIMData propose par défaut cinq catégories de paramètres :
* **Statuts** (Opened, Closed, Resolved)
* **Tags** (Architecture, Structural, MEP, Heating)
-
+
## Personnalisation des paramètres
@@ -52,4 +52,4 @@ BIMData vous permet de personnaliser ces listes en fonction des besoins spécifi
* **Modifier** des éléments existants (par exemple, remplacer "Medium" par "Moyen").
* **Supprimer** les éléments qui ne sont pas pertinents pour votre projet.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/compte-de-facturation.md b/src/user-guide/bimdata-platform/compte-de-facturation.md
index a90c05c..2c0dc9d 100644
--- a/src/user-guide/bimdata-platform/compte-de-facturation.md
+++ b/src/user-guide/bimdata-platform/compte-de-facturation.md
@@ -6,7 +6,7 @@ Le **compte de facturation** est l’entité qui centralise la **gestion des abo
La **création** et l’**édition** des comptes de facturation se fait uniquement depuis la page **“Mes espaces”**, via le bouton **“Comptes de facturation”** (en haut à droite).
-
+
## Abonnements
diff --git a/src/user-guide/bimdata-platform/espace.md b/src/user-guide/bimdata-platform/espace.md
index 04a1a34..c980f02 100644
--- a/src/user-guide/bimdata-platform/espace.md
+++ b/src/user-guide/bimdata-platform/espace.md
@@ -2,11 +2,11 @@
Un **"espace"** sur la plateforme BIMData représente une unité organisationnelle dédiée à la gestion de vos projets.
-
+
Chaque espace regroupe un ensemble de projets spécifiques et dispose de sa propre gestion des droits utilisateur, vous permettant de contrôler précisément les accès et les permissions pour chaque membre de l’équipe.
-
+
En outre, chaque espace est associé à un **compte de facturation distinct**, facilitant ainsi la gestion financière et le suivi des coûts pour l’ensemble des projets qu’il englobe.
diff --git a/src/user-guide/bimdata-platform/ged/arborescence.md b/src/user-guide/bimdata-platform/ged/arborescence.md
index 42a64a1..eb3819e 100644
--- a/src/user-guide/bimdata-platform/ged/arborescence.md
+++ b/src/user-guide/bimdata-platform/ged/arborescence.md
@@ -2,7 +2,7 @@
### Créer des dossiers et importer des fichiers dans la GED
-
+
La **GED BIMData** permet une organisation efficace de vos documents grâce à la création de dossiers et l’importation de fichiers.
diff --git a/src/user-guide/bimdata-platform/ged/fonctionnalites-avancees.md b/src/user-guide/bimdata-platform/ged/fonctionnalites-avancees.md
index 28ab527..6674b74 100644
--- a/src/user-guide/bimdata-platform/ged/fonctionnalites-avancees.md
+++ b/src/user-guide/bimdata-platform/ged/fonctionnalites-avancees.md
@@ -4,7 +4,7 @@ La plateforme BIMData propose plusieurs fonctionnalités pratiques pour gérer v
## Importer la structure d’un autre projet
-
+
Si vous êtes administrateur, vous pouvez importer la structure de fichiers d’un autre projet situé dans le même espace de travail :
@@ -15,7 +15,7 @@ Si vous êtes administrateur, vous pouvez importer la structure de fichiers d’
## Charger un dossier via drag and drop
-
+
La plateforme simplifie l’importation en vous permettant de **glisser-déposer** vos dossiers directement dans l’interface de la GED.
diff --git a/src/user-guide/bimdata-platform/ged/gestion-des-droits-d-acces.md b/src/user-guide/bimdata-platform/ged/gestion-des-droits-d-acces.md
index 52414d4..4a74b16 100644
--- a/src/user-guide/bimdata-platform/ged/gestion-des-droits-d-acces.md
+++ b/src/user-guide/bimdata-platform/ged/gestion-des-droits-d-acces.md
@@ -6,19 +6,19 @@ La plateforme BIMData vous permet de gérer précisément les droits d'accès à
Accédez à la gestion/création de vos groupes en haut à droite sur votre page projet.
-
+
Vous pouvez créer des groupes et y ajouter ou supprimer des utilisateurs selon vos besoins. La création de groupes est un **pré-requis** pour la gestion des droits d’accès aux dossiers : les permissions se définissent **au niveau des groupes d’utilisateurs**, et non directement utilisateur par utilisateur. Cela permet d’appliquer ou de modifier des droits pour plusieurs personnes en une seule opération.
## Importation de groupes existants
-
+
Pour gagner du temps, vous pouvez également importer les groupes utilisateurs d'autres projets dans lesquels vous êtes administrateur. Pour cela, cliquez sur **"Importer un groupe"**, en haut à droite de la page **"Gestion des groupes"**, et sélectionnez les groupes que vous souhaitez intégrer.
## Paramétrage des droits d'accès
-
+
Pour chaque groupe, vous pouvez définir les niveaux d'accès aux dossiers de votre GED :
diff --git a/src/user-guide/bimdata-platform/ged/gestion-des-versions.md b/src/user-guide/bimdata-platform/ged/gestion-des-versions.md
deleted file mode 100644
index f775aea..0000000
--- a/src/user-guide/bimdata-platform/ged/gestion-des-versions.md
+++ /dev/null
@@ -1 +0,0 @@
-# Gestion des versions
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/ged/introduction.md b/src/user-guide/bimdata-platform/ged/introduction.md
index 1486a78..3f0948d 100644
--- a/src/user-guide/bimdata-platform/ged/introduction.md
+++ b/src/user-guide/bimdata-platform/ged/introduction.md
@@ -8,4 +8,4 @@ Un processus de **VISA** est également disponible pour encadrer la validation d
Enfin, l’accès aux documents est encadré par une **gestion des droits**. Selon votre rôle et les permissions définies au niveau de l’espace et/ou du projet, vous pouvez consulter, ajouter, modifier, supprimer ou télécharger des fichiers. Cette gestion permet d’adapter l’accès à la GED aux responsabilités de chacun et de limiter les actions sensibles aux personnes autorisées.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/ged/navigation.md b/src/user-guide/bimdata-platform/ged/navigation.md
index 2b23f83..c2602e9 100644
--- a/src/user-guide/bimdata-platform/ged/navigation.md
+++ b/src/user-guide/bimdata-platform/ged/navigation.md
@@ -2,7 +2,7 @@
La GED s’adapte à vos projets et permet de réaliser des opérations destinées à centraliser, organiser, archiver et à sécuriser vos documents.
-
+
Dans la GED (Gestion Électronique des Documents) de BIMData, la navigation se fait via trois onglets principaux pour une gestion optimale de vos documents de projet :
@@ -14,4 +14,4 @@ Dans la GED (Gestion Électronique des Documents) de BIMData, la navigation se f
Cette structure en onglets rend la gestion documentaire simple et efficace, en s'adaptant aux besoins spécifiques de votre projet.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/ged/versionning.md b/src/user-guide/bimdata-platform/ged/versionning.md
index 1c59e4c..bd74067 100644
--- a/src/user-guide/bimdata-platform/ged/versionning.md
+++ b/src/user-guide/bimdata-platform/ged/versionning.md
@@ -4,7 +4,7 @@ La plateforme BIMData propose une fonctionnalité d'historique de version pour a
## Ajout d’une nouvelle version
-
+
* Depuis la **GED**, accédez au menu du fichier souhaité.
* Cliquez sur **"Ajouter une version"**.
@@ -12,11 +12,11 @@ La plateforme BIMData propose une fonctionnalité d'historique de version pour a
## Historique des versions
-
+
Une fois plusieurs versions ajoutées, vous pourrez :
* **Consulter les documents :** ouvrez les différentes versions du fichier si elles sont compatibles avec la visionneuse BIMData.
* **Restaurer une version précédente :** revenez à une version antérieure si nécessaire.
* **Supprimer des versions :** supprimez des versions obsolètes ou inutiles.
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/ged/visa.md b/src/user-guide/bimdata-platform/ged/visa.md
index 75f9b12..2ecfde6 100644
--- a/src/user-guide/bimdata-platform/ged/visa.md
+++ b/src/user-guide/bimdata-platform/ged/visa.md
@@ -4,13 +4,13 @@ La fonctionnalité **VISA** permet de gérer une validation **simple** des docum
## Accès à la fonctionnalité VISA
-
+
Depuis la **GED**, vous pouvez accéder à cette fonctionnalité directement via le menu d’un fichier. Cliquez sur **"Demande de validation"** pour initier une nouvelle demande.
## Création d’une demande de validation
-
+
Une fois cette option sélectionnée, un formulaire s’affiche.
@@ -21,7 +21,7 @@ Vous pourrez :
## Suivi et gestion des VISA
-
+
Une fois la demande validée, vous pourrez suivre et gérer vos demandes de validation directement dans l’onglet **"Mes visas"** de la GED. Cet espace regroupe :
diff --git a/src/user-guide/bimdata-platform/page-projet.md b/src/user-guide/bimdata-platform/page-projet.md
index 4c41559..001732f 100644
--- a/src/user-guide/bimdata-platform/page-projet.md
+++ b/src/user-guide/bimdata-platform/page-projet.md
@@ -9,7 +9,7 @@ Cet espace vous permet de :
* tester la visionneuse 3D BIMData,
* explorer une maquette numérique directement depuis votre compte.
-
+
## Navigation dans la page projet
@@ -21,13 +21,13 @@ En haut de la page, vous trouverez les principaux éléments de navigation :
- GED
- BCF
-
+
## Prévisualisation et localisation
Le premier bloc de la page projet vous offrira une prévisualisation ainsi que des informations de localisation du/des modèles (.ifc, .dwg, .dxf, .pdf) préalablement téléchargés dans votre projet projet.
-
+
### Modifier la localisation
@@ -36,7 +36,7 @@ Pour renseigner ou modifier l’adresse du modèle :
1. Cliquez sur le bouton **"Édition"** en haut à droite de la vue plan.
2. Saisissez la nouvelle adresse.
-
+
## Gestion des utilisateurs
@@ -45,7 +45,7 @@ Pour renseigner ou modifier l’adresse du modèle :
- la gestion des **invitations**,
- la gestion des **droits utilisateurs** du projet.
-
+
## Gestionnaire de modèles
@@ -53,7 +53,7 @@ Le **Gestionnaire de modèles** est la vue dédiée pour **organiser, retrouver
Il propose une navigation par **onglets** (ex. **.ifc**, **.dwg**, **.dxf**, **.pdf**, **nuages de points**, **photos**, etc.) qui permet de filtrer rapidement le contenu — comme une vue “orientée métier” de la GED.
-
+
### Ouvrir les fichiers dans la visionneuse BIMData
Depuis le Gestionnaire de modèles, vous pouvez **ouvrir les fichiers compatibles** directement dans la **visionneuse multi-formats BIMData** (ex. IFC, PDF, images, etc.), pour consulter et partager sans téléchargement.
@@ -76,13 +76,13 @@ Vous pouvez ajouter un nouveau modèle de deux façons :
Cliquez sur le bouton **"Ajouter un modèle"**.
-
+
### 2. Depuis le gestionnaire de modèles
1. Rendez-vous dans le bloc **Gestionnaire de modèles**.
2. Cliquez sur le bouton **"Ajouter"** en haut à droite.
-
+
> **_NOTE:_** Une fois votre "modèle" (.ifc, .dwg, .dxf, .pdf, nuages de points, photos) téléchargé dans votre projet, s'ensuivra l'étape de conversion plus ou moins longue selon le poids et le type de fichier.
\ No newline at end of file
diff --git a/src/user-guide/bimdata-platform/tableau-de-bord.md b/src/user-guide/bimdata-platform/tableau-de-bord.md
index 22b2b38..d5f8465 100644
--- a/src/user-guide/bimdata-platform/tableau-de-bord.md
+++ b/src/user-guide/bimdata-platform/tableau-de-bord.md
@@ -2,7 +2,7 @@
La page d'accueil de la plateforme se présente sous la forme d'un tableau de bord. Vous y trouverez un accès direct à vos espaces et projets récents.
-
+
### Espace de démo
diff --git a/src/user-guide/creer-un-compte-bimdata.md b/src/user-guide/creer-un-compte-bimdata.md
index d52547f..d9d9d8e 100644
--- a/src/user-guide/creer-un-compte-bimdata.md
+++ b/src/user-guide/creer-un-compte-bimdata.md
@@ -15,7 +15,7 @@ Inscrivez-vous à BIMData avec votre **adresse e-mail** et un **mot de passe uni
5. Cliquez sur le bouton **S'enregistrer** pour terminer le processus.
6. BIMData vous enverra un e-mail pour vérifier votre compte. Ouvrez cet e-mail et cliquez sur le bouton de vérification pour terminer le processus et vous connecter à votre nouveau compte BIMData.
-
+
## Et ensuite ?
diff --git a/src/viewer/examples/README.md b/src/viewer/examples/index.md
similarity index 100%
rename from src/viewer/examples/README.md
rename to src/viewer/examples/index.md
diff --git a/src/viewer/guide/README.md b/src/viewer/guide/index.md
similarity index 67%
rename from src/viewer/guide/README.md
rename to src/viewer/guide/index.md
index 3684039..e05ec43 100644
--- a/src/viewer/guide/README.md
+++ b/src/viewer/guide/index.md
@@ -4,16 +4,16 @@ This guide shows how to quickly customize the existing BIMDataViewer UI.
## Header & Windows
-As the name suggests, the [**Header**](../reference/header.html) is located at the top of the BIMDataViewer. [**Windows**](../reference/window.html) share the remaining space.
+As the name suggests, the [**Header**](../reference/header) is located at the top of the BIMDataViewer. [**Windows**](../reference/window) share the remaining space.
-
+
-Different layouts can be created, with or without [**Header**](../reference/header.html), and with as many [**Windows**](../reference/window.html) as required.
+Different layouts can be created, with or without [**Header**](../reference/header), and with as many [**Windows**](../reference/window) as required.
-
+
-It is possible to completly remove the [**Header**](../reference/header.html) using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer.html) configuration parameter:
+It is possible to completly remove the [**Header**](../reference/header) using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer) configuration parameter:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -23,7 +23,7 @@ const bimdataViewer = makeBIMDataViewer({
});
```
-To display the desire layout, use the second parameter of the [`bimdataViewer.mount`](../reference/mount.html) method:
+To display the desire layout, use the second parameter of the [`bimdataViewer.mount`](../reference/mount) method:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -52,13 +52,13 @@ bimdataViewer.mount("#viewer", layout);
And you get the following layout:
-
+
## BIMData Logo and Viewer Version
-By default, the BIMData Logo and the Viewer version are displayed on the UI. They may change location depending on the number of [**Windows**](../reference/window.html). If only one [**Window**](../reference/window.html) without [**Header**](../reference/header.html), they are displayed on the bottom left corner of the UI. Else, they are displayed on the right of the [**Header**](../reference/header.html).
+By default, the BIMData Logo and the Viewer version are displayed on the UI. They may change location depending on the number of [**Windows**](../reference/window). If only one [**Window**](../reference/window) without [**Header**](../reference/header), they are displayed on the bottom left corner of the UI. Else, they are displayed on the right of the [**Header**](../reference/header).
-They can be removed using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer.html) configuration parameter:
+They can be removed using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer) configuration parameter:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -79,7 +79,6 @@ You can overide any color you want to change using a value as a `string` represe
```javascript
const bimdataViewer = makeBIMDataViewer({
- /* */
ui: {
style: {
backgroundColor: "",
diff --git a/src/viewer/guide/plugins.md b/src/viewer/guide/plugins.md
index 489bd1c..53e139c 100644
--- a/src/viewer/guide/plugins.md
+++ b/src/viewer/guide/plugins.md
@@ -50,7 +50,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
### Plugin as button
@@ -71,7 +71,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
- **panel** : plugin content displayed on the whole [**Window**](../reference/window.html) height.
@@ -88,7 +88,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
- **free** : plugin content displayed on the side of the button, without any layout. Its size is determined by its content.
@@ -105,7 +105,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
:::tip
Checkout [the example about the GUI Layout](../examples/gui_layout.html) for practical application.
@@ -115,7 +115,7 @@ Checkout [the example about the GUI Layout](../examples/gui_layout.html) for pra
The [**Context Menu**](../reference/context_menu.html) and the [**Keyobard Shortcuts**](../reference/keyboard_shortcuts.html) can be personalized using [**Plugins**](../reference/plugin.html).
-
+
Both of them take into account the context of the request. In this way, it is possible to launch a specific action in a particular [**Window**](../reference/window.html) when a keyboard key is pressed while the mouse is hovering that [**Window**](../reference/window.html). In the same way, it is possible to add to the [**Context Menu**](../reference/context_menu.html) only a list of commands specific to the place where the click was made.
@@ -221,8 +221,8 @@ A good image to see the difference between the bounds of the [`localContext`](..
Local context spinner
-
-
+
+
`
diff --git a/src/viewer/README.md b/src/viewer/index.md
similarity index 75%
rename from src/viewer/README.md
rename to src/viewer/index.md
index 23678eb..2348221 100644
--- a/src/viewer/README.md
+++ b/src/viewer/index.md
@@ -1,5 +1,14 @@
# Getting started
+
+
## Introduction
The BIMData Viewer is a tool for interacting with models of different formats like :
@@ -11,10 +20,10 @@ The BIMData Viewer is a tool for interacting with models of different formats li
Each model format is handled by its own native built-in viewer and interactions include **display**, **navigation**, **measurement** and **annotation**.
-The BIMData Viewer is binded to the [BIMData API](/api/introduction/overview.html) and you can directly upload models using it or using the [BIMData platform](https://platform.bimdata.io/).
+The BIMData Viewer is binded to the [BIMData API](/api/introduction/overview) and you can directly upload models using it or using the [BIMData platform](https://platform.bimdata.io/).
-[The UI can be customized](./guide/README.md#graphical-user-interface) to organize the workspace as you need and a flexible javascript API using
-[ Vue.js 3](https://vuejs.org/) allows to create custom plugins to match your business perfectly.
+[The UI can be customized](./guide/index#graphical-user-interface) to organize the workspace as you need and a flexible javascript API using
+[Vue 3](https://vuejs.org/) allows to create custom plugins to match your business perfectly.
However, you don't need to master Vue.js to develop a plugin and you can still update the DOM with jQuery if you like!
@@ -23,11 +32,9 @@ However, you don't need to master Vue.js to develop a plugin and you can still u
You can directly download the BIMDataViewer from a **CDN** or you can install the [`@bimdata/viewer` package](https://www.npmjs.com/package/@bimdata/viewer) using **NPM**.
-
-
-
+::: code-group
-```html
+```html [CDN]
@@ -59,11 +66,8 @@ You can directly download the BIMDataViewer from a **CDN** or you can install th
```
-
-
-
-```html
+```html [NPM]
@@ -95,6 +99,4 @@ You can directly download the BIMDataViewer from a **CDN** or you can install th
```
-
-
-
+:::
diff --git a/src/viewer/mobile.md b/src/viewer/mobile.md
index 448a4ec..053be10 100644
--- a/src/viewer/mobile.md
+++ b/src/viewer/mobile.md
@@ -13,7 +13,7 @@ bimdataViewer.mount("#app", "mobile");
```
-
+
The plugin is composed of **three** main elements from top to bottom:
@@ -46,7 +46,7 @@ bimdataViewer.mount("#app", "mobile-plan");
```
-
+
## Loading model
diff --git a/src/viewer/reference/$viewer.md b/src/viewer/reference/$viewer.md
index 47210d5..44af80f 100644
--- a/src/viewer/reference/$viewer.md
+++ b/src/viewer/reference/$viewer.md
@@ -260,8 +260,8 @@ this.$viewer.localContext.loadingProcessStart();
Local context spinner
-
-
+
+
To stop spinners use the following methods:
diff --git a/src/viewer/reference/README.md b/src/viewer/reference/index.md
similarity index 100%
rename from src/viewer/reference/README.md
rename to src/viewer/reference/index.md
diff --git a/src/viewer/reference/mount.md b/src/viewer/reference/mount.md
index c2b890d..416b8bc 100644
--- a/src/viewer/reference/mount.md
+++ b/src/viewer/reference/mount.md
@@ -60,4 +60,4 @@ const layout = {
The result is the following UI layout:
-
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/viewer/reference/native_plugins.md b/src/viewer/reference/native_plugins.md
index b4d7fcd..0557f09 100644
--- a/src/viewer/reference/native_plugins.md
+++ b/src/viewer/reference/native_plugins.md
@@ -54,7 +54,7 @@ The BCF plugin will be useless if BCF Manager is not enabled.
The Drawing Tools plugin allows to enrich plans from the [**viewer plan**](#viewer-plan) with drawings. Drawings can be predefined shapes like lines, arrows, circles or rectangles, free hand drawings or texts. Except for texts, the line width and the color can be customized for each drawing. Once created, the drawings are stored on the BIMData API. It is possible to move or delete drawings using the corresponding tools (pointer / eraser). It is also possible to edit the text drawing by clicking on them while the text tool is active. Once the input is active, the font size and the text content can be changed.
-The Drawing Tools plugin is disabled by default. To enable it, add the following entry into the `plugins` property object of the [`makeBimdataViewer`](#native-plugins) function:
+The Drawing Tools plugin is disabled by default. To enable it, add the following entry into the `plugins` property object of the [`makeBIMDataViewer`](#native-plugins) function:
```js
const viewer = makeBIMDataViewer({
diff --git a/src/viewer/reference/plugin.md b/src/viewer/reference/plugin.md
index 5192efb..20a30cb 100644
--- a/src/viewer/reference/plugin.md
+++ b/src/viewer/reference/plugin.md
@@ -67,7 +67,7 @@ A plugin component is a [Vuejs 3.x component](https://vuejs.org/guide/essentials
By default, a plugin component is displayed on the window content. (the orange area on the image below)
-
+
Some additional properties are natively available on the component instance: (`this` on computed, lifeCycles, methods...)
@@ -125,15 +125,15 @@ A plugin as button can be displayed in 3 different ways, defined by the plugin `
- **simple** : plugin content displayed close to its corresponding button, on a small panel.
-
+
- **panel** : plugin content displayed on the whole window height.
-
+
- **free** : plugin content displayed on the side of the button, without any layout. Its size is determined by its content.
-
+
### Additional Component API
@@ -170,7 +170,7 @@ const myComponent = {
The result:
-
+
These methods are useful when an action needs to be awaited before the plugin can be opened or closed again.
diff --git a/src/viewer/release_notes.md b/src/viewer/release_notes.md
index e8a7014..eee7554 100644
--- a/src/viewer/release_notes.md
+++ b/src/viewer/release_notes.md
@@ -30,13 +30,13 @@
* Mobile: fix 3D engine setup and 2D camera positioning
* Point Cloud: tile handle full rootTransform matrix
-## v2.16.1
+## v2.16.1 (2026-01-22)
### Bugfixes
* DWG: fix new Engine 2D integration
-## v2.16.0
+## v2.16.0 (2026-01-08)
### Features
@@ -46,13 +46,13 @@
* Plan: fix drawings in PDF models
-## v2.15.1
+## v2.15.1 (2026-01-07)
### Bugfixes
* Plan: fix measurement plugin
-## v2.15.0
+## v2.15.0 (2025-12-09)
### Features
@@ -65,7 +65,7 @@
* Point Cloud: fix tiles center positioning
* Plan: fix model transform with multiple plans
-## v2.14.0
+## v2.14.0 (2025-11-14)
### Features
@@ -81,7 +81,7 @@
* BCF: properly handle overflow for topic objects list
* i18n: update and fix translations for English, German and Spanish
-## v2.13.0
+## v2.13.0 (2025-10-27)
### Features
@@ -97,7 +97,7 @@
* Fix caliper for DWG measures
* Plan: Fix `fitView` for zones/spaces
-## v2.12.0
+## v2.12.0 (2025-07-30)
### Features
@@ -116,7 +116,7 @@
* Plan: fix bug when spam clicking 'next page' button
* Plan: use Pointer Events instead of Touch Events in drawing-tools
-## v2.11.0
+## v2.11.0 (2025-06-11)
### Features
@@ -135,14 +135,14 @@
* Plan: fix drawings on PDF pages
* Plan: fix PDF export on chromium based browsers
-## v2.10.1
+## v2.10.1 (2025-05-12)
### Bugfixes
* Avoid error when switching PDF pages quickly
* Update API client to v10.21.3
-## v2.10.0
+## v2.10.0 (2025-04-28)
### Features
@@ -153,7 +153,7 @@
* BCF comment snapshot with multi-windows was broken
* DWG Layers CSS issue
-## v2.9.0
+## v2.9.0 (2025-04-23)
### Features
@@ -171,7 +171,7 @@
* Fix: children count in IFC structure tree
* Fix: PDF viewer window resize
-## v2.8.0
+## v2.8.0 (2025-03-10)
### Features
@@ -181,7 +181,7 @@
* Fix plan section deletion error
-## v2.7.0
+## v2.7.0 (2025-02-17)
### Features
@@ -195,7 +195,7 @@
* Fix BCF annotation edition (create/update/delete)
* Avoid annotation drag & drop on right-click
-## v2.6.1
+## v2.6.1 (2024-12-12)
### Features
@@ -204,7 +204,7 @@
* Smartview show/hide feature
* Edit smartviews feature
-## v2.6.0
+## v2.6.0 (2024-11-18)
### Feature
@@ -221,7 +221,7 @@
* Many fixes in PDF exports with drawings
* Fix performance issue with Minimap
-## v2.5.0
+## v2.5.0 (2024-09-25)
### Feature
@@ -243,7 +243,7 @@
* Fix(Viewer Plan): properly handle models without document
* Fix: add touch event for 3D annotation mode & annotations drag & drop
-## v2.4.1
+## v2.4.1 (2024-08-14)
### Bugfixes
@@ -251,7 +251,7 @@
* Fix persistent spinner when opening BCF Manager
* Fix Meta-Building storey change handler
-## v2.4.0
+## v2.4.0 (2024-08-09)
### BREAKING CHANGES
@@ -314,7 +314,7 @@ See [viewer reference](./reference/annotations.md) to learn more.
* Fix 3D annotations visibility update
* Fix IFC property edition
-## v2.3.0
+## v2.3.0 (2024-06-27)
### Features
@@ -336,7 +336,7 @@ See [viewer reference](./reference/annotations.md) to learn more.
* Fix: `buildingElevation` fallbacks to `siteElevation` if not set
* Fix: model loader spinner on initialization
-## v2.2.0
+## v2.2.0 (2024-04-29)
### Features
@@ -351,7 +351,7 @@ See [viewer reference](./reference/annotations.md) to learn more.
* BCF topic auto open
* Fix typos
-## v2.1.0
+## v2.1.0 (2024-03-22)
### Features
@@ -366,7 +366,7 @@ See [viewer reference](./reference/annotations.md) to learn more.
* add bcfApi and collaborationApi offline customization options.
* remove deprecated of local context & global context plugins getters.
-## v2.0.0
+## v2.0.0 (2024-03-07)
### BREAKING CHANGES
@@ -474,7 +474,7 @@ export default defineConfig(() => {
});
```
-## v1.10.1
+## v1.10.1 (2023-06-14)
#### Usages
@@ -521,7 +521,7 @@ export default defineConfig(() => {
* Do not clear object selection when opening BCF creation form
* Handle deprecated BIMDataAPI IfcApi methods properly
-## v1.9.0
+## v1.9.0 (2022-11-24)
#### Usages
@@ -584,17 +584,17 @@ export default defineConfig(() => {
* Fix properties showing last selected object
* Hide plugin as button tooltip while the plugin is open
-## v1.8.2
+## v1.8.2 (2021-11-12)
#### Developers
* Add [`translateIfcEntities` option](/viewer/reference/native_plugins.html#structure-and-properties)
-## v1.8.1
+## v1.8.1 (2021-11-10)
#### Developers
* `getLastEvent` is now referenced in `index.d.ts`. Don't forget to use it (even with .js files) to bring auto-complete in your development tools.
-## v1.8.0
+## v1.8.0 (2021-11-10)
#### Usages
* 2D Measurement can now snap to lines. Press CTRL (or cmd) while measuring.
* 3D and 2D camera synchronization is now available in 2D parameters.
@@ -607,28 +607,28 @@ export default defineConfig(() => {
* Events now have an option `getLastEvent`. If `true`, the last event (if any) is instantly triggered. It is useful for state synchronization on plugin initialization.
-## v1.7.4
+## v1.7.4 (2021-10-18)
#### Usages
* Archived models can now be loaded in multi-model if the first model loaded is archived
-## v1.7.3
+## v1.7.3 (2021-10-13)
#### Usages
* Add first iteration of Spanish translations
-## v1.7.2
+## v1.7.2 (2021-10-11)
#### Usages
* Add first iteration of German translations
-## v1.7.1
+## v1.7.1 (2021-09-29)
#### Developers
* Alerts plugin is now enabled on 2d window by default
#### Bugfixes
* Update api client to fix issues with `getExtensions`, `updateExtensions`, `createClassificationElementRelations` and `listClassificationElementRelations` methods
-## v1.7.0
+## v1.7.0 (2021-09-17)
#### Usages
* New menu to select windowed plugins
* New UI to manage viewers and windows
@@ -657,17 +657,17 @@ export default defineConfig(() => {
* Object state is now correctly set when opening a new 3D window
-## v1.6.2
+## v1.6.2 (2021-05-12)
#### Bugfixes
* Fix bug with logarithmicDepthBuffer. It could cause glitches if two surfaces were too close to each other
-## v1.6.1
+## v1.6.1 (2021-05-10)
#### Usages
* Improve default 2D and 3D parameters (Edges, highlight, spaces and space names are enabled by default)
-## v1.6.0
+## v1.6.0 (2021-05-10)
#### Usages
* Brand new 2D viewer
* Faster and more accurate rendering
@@ -688,12 +688,12 @@ export default defineConfig(() => {
* Fix loadIfc method when ifcId is a string instead of an integer
-## v1.5.6
+## v1.5.6 (2021-03-25)
#### Bugfixes
* Performance fixes
-## v1.5.0
+## v1.5.0 (2021-02-19)
#### Developers
* Add [showAllAnnotations option](/viewer/reference/native_plugins.html#bcf) to BCF plugin
* Add structure window as available window by default. `bimdataViewer.unregisterWindow('structure')` to remove it.
@@ -705,12 +705,12 @@ export default defineConfig(() => {
* Fix xraySetters
-## v1.4.1
+## v1.4.1 (2021-02-08)
#### Bugfixes
* Fix [object properties](/viewer/reference/state.html#object) that may not be accessible in some contexts
-## v1.4.0
+## v1.4.0 (2021-02-02)
#### Usages
* Improve 3D rendering performances up to 25%
@@ -725,7 +725,7 @@ export default defineConfig(() => {
* Fix plugin `$close()` triggered even if the plugin wasn't opened when `keepOpen = false`
-## v1.3.0
+## v1.3.0 (2021-01-20)
#### Usages
* New Section planes tool
@@ -769,10 +769,9 @@ Major features:
#### ES Module
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
import BIMDataViewer from "@bimdata/viewer";
const cfg = {
@@ -786,12 +785,10 @@ const cfg = {
}
};
const accessToken = 'DEMO_TOKEN';
-const {viewer, store, eventHub, setAccessToken} = initBIMDataViewer('app', accessToken, cfg);
+const { viewer, store, eventHub, setAccessToken } = initBIMDataViewer('app', accessToken, cfg);
```
-
-
-```javascript
+```javascript [Version 1.x]
import makeBIMDataViewer from "@bimdata/viewer";
const bimdataViewer = makeBIMDataViewer({
@@ -813,10 +810,8 @@ const bimdataViewer = makeBIMDataViewer({
const vm = bimdataViewer.mount("#app");
```
-
-
-```javascript
+```javascript [Both]
/******* VERSION 0.X *******/
import BIMDataViewer from "@bimdata/viewer";
@@ -832,7 +827,7 @@ const cfg = {
}
};
const accessToken = 'DEMO_TOKEN';
-const {viewer, store, eventHub, setAccessToken} = initBIMDataViewer('app', accessToken, cfg);
+const { viewer, store, eventHub, setAccessToken } = initBIMDataViewer('app', accessToken, cfg);
/******* VERSION 1.X *******/
@@ -857,70 +852,55 @@ const bimdataViewer = makeBIMDataViewer({
const vm = bimdataViewer.mount("#app");
```
-
-
-
+:::
#### Script tag
-
-
+::: code-group
-```html
+```html [Version 0.x]
```
-
-
-```html
+```html [Version 1.x]
```
-
-
+:::
#### Refresh access token
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
const {viewer, store, eventHub, setAccessToken} = initBIMDataViewer('app', accessToken, cfg);
setAccessToken(newToken);
```
-
-
-```javascript
+```javascript [Version 1.x]
bimdataViewer.setAccessToken(newToken);
```
-
-
+:::
#### Change language
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
const {viewer, store, eventHub, setAccessToken} = initBIMDataViewer('app', accessToken, cfg);
viewer.$i18n.locale = locale;
```
-
-
-```javascript
+```javascript [Version 1.x]
viewerVm.$i18n.locale = locale;
```
-
-
+:::
### Plugin configuration file
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
export default {
name: "bimObjectPlugin",
component: BimobjectComponent,
@@ -945,10 +925,8 @@ export default {
},
};
```
-
-
-```javascript
+```javascript [Version 1.x]
export default {
name: "bimObjectPlugin",
component: BimobjectComponent,
@@ -974,10 +952,8 @@ export default {
},
};
```
-
-
-```javascript
+```javascript [Both]
/******* VERSION 0.X *******/
export default {
@@ -1031,8 +1007,7 @@ export default {
},
};
```
-
-
+:::
### Plugin API
@@ -1046,58 +1021,46 @@ Version 0.x used objects `uuids` as `id`. To handle identical `uuids` (eg: in mo
There are `uuids` utilities. See the [state reference](/viewer/reference/state.html#ids-and-uuids).
:::
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$hub.on("select-objects", ({ ids }) => { /* Do something with ids. */ });
```
-
-
-```javascript
+```javascript [Version 1.x]
this.$viewer.state.hub.on("objects-selected", ({ objects }) => { /* Do something with objects. */ });
```
-
-
+:::
#### Setters
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$hub.emit("select-objects", { ids: [/* object ids to be selected */] });
```
-
-
-```javascript
+```javascript [Version 1.x]
this.$viewer.state.selectObjects([/* object ids to be selected */]);
```
-
-
+:::
#### Getters
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$utils.getCloudId();
this.$utils.getProjectId();
this.$utils.getAccessToken();
```
-
-
-```javascript
+```javascript [Version 1.x]
this.$viewer.api.cloudId;
this.$viewer.api.projectId;
this.$viewer.api.accessToken;
```
-
-
+:::
::: tip
- [$viewer reference](/viewer/reference/$viewer.html#viewer).
@@ -1106,43 +1069,35 @@ this.$viewer.api.accessToken;
#### BIMData API Client
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
const apiClient = new this.$bimdataApiClient.IfcApi();
```
-
-
-```javascript
+```javascript [Version 1.x]
const apiClient = new this.$viewer.api.apiClient.IfcApi();
// All API calls are the same
```
-
-
+:::
#### Structure helpers
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$utils.getObjectParent(id);
this.$utils.getObjectSpace(id);
this.$utils.getObjectAncestorByType(id, type);
```
-
-
-```javascript
+```javascript [Version 1.x]
// structure methods are now object's methods
object.parent;
object.space;
object.getFirstAncestorWithType(type);
```
-
-
+:::
::: tip
See [state object reference](/viewer/reference/state.html#object).
@@ -1150,65 +1105,53 @@ See [state object reference](/viewer/reference/state.html#object).
#### Model Loading
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$utils.loadIfc(ifcs);
this.$utils.unloadIfc(ifcs);
const loadedIfc = this.$utils.getSelectedIfcs()[0];
```
-
-
-```javascript
+```javascript [Version 1.x]
await this.$viewer.state.loadIfcs([ifcIds]);
// Resolve when ifcs are added in the state, not when the 3D viewer has loaded them
this.$viewer.state.unloadIfcs([ifcIds]);
const loadedIfc = this.$viewer.state.ifcs[0];
```
-
-
+:::
#### Error message
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$hub.emit("alert", {
type: "success",
message: this.$t("successMessage"),
});
```
-
-
-```javascript
+```javascript [Version 1.x]
this.$viewer.localContext.hub.emit("alert", {
type: "success",
message: this.$t("bimObjectPlugin.successMessage"),
});
```
-
-
+:::
#### Modals
-
-
+::: code-group
-```javascript
+```javascript [Version 0.x]
this.$plugins.modalManager.pushModal(modal);
```
-
-
-```javascript
+```javascript [Version 1.x]
this.$viewer.globalContext.modals.pushModal(modal);
```
-
-
+:::
diff --git a/src/viewer/viewer_sdk.md b/src/viewer/viewer_sdk.md
index a8fe956..9fd194a 100644
--- a/src/viewer/viewer_sdk.md
+++ b/src/viewer/viewer_sdk.md
@@ -6,7 +6,7 @@ We have pre-configured a **VueJS** environment to develop BIMData Viewer plugins
In this section, you get tutorials and references for installing and using the [BIMData Viewer SDK](https://github.com/bimdata/bimdata-viewer-sdk)
-
+
## Setup
- 
+
-Different layouts can be created, with or without [**Header**](../reference/header.html), and with as many [**Windows**](../reference/window.html) as required.
+Different layouts can be created, with or without [**Header**](../reference/header), and with as many [**Windows**](../reference/window) as required.
-
+
-It is possible to completly remove the [**Header**](../reference/header.html) using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer.html) configuration parameter:
+It is possible to completly remove the [**Header**](../reference/header) using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer) configuration parameter:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -23,7 +23,7 @@ const bimdataViewer = makeBIMDataViewer({
});
```
-To display the desire layout, use the second parameter of the [`bimdataViewer.mount`](../reference/mount.html) method:
+To display the desire layout, use the second parameter of the [`bimdataViewer.mount`](../reference/mount) method:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -52,13 +52,13 @@ bimdataViewer.mount("#viewer", layout);
And you get the following layout:
-
+
## BIMData Logo and Viewer Version
-By default, the BIMData Logo and the Viewer version are displayed on the UI. They may change location depending on the number of [**Windows**](../reference/window.html). If only one [**Window**](../reference/window.html) without [**Header**](../reference/header.html), they are displayed on the bottom left corner of the UI. Else, they are displayed on the right of the [**Header**](../reference/header.html).
+By default, the BIMData Logo and the Viewer version are displayed on the UI. They may change location depending on the number of [**Windows**](../reference/window). If only one [**Window**](../reference/window) without [**Header**](../reference/header), they are displayed on the bottom left corner of the UI. Else, they are displayed on the right of the [**Header**](../reference/header).
-They can be removed using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer.html) configuration parameter:
+They can be removed using the `ui` property of the [`makeBIMDataViewer`](../reference/makeBIMDataViewer) configuration parameter:
```js
const bimdataViewer = makeBIMDataViewer({
@@ -79,7 +79,6 @@ You can overide any color you want to change using a value as a `string` represe
```javascript
const bimdataViewer = makeBIMDataViewer({
- /* */
ui: {
style: {
backgroundColor: "",
diff --git a/src/viewer/guide/plugins.md b/src/viewer/guide/plugins.md
index 489bd1c..53e139c 100644
--- a/src/viewer/guide/plugins.md
+++ b/src/viewer/guide/plugins.md
@@ -50,7 +50,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
### Plugin as button
@@ -71,7 +71,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
- **panel** : plugin content displayed on the whole [**Window**](../reference/window.html) height.
@@ -88,7 +88,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
- **free** : plugin content displayed on the side of the button, without any layout. Its size is determined by its content.
@@ -105,7 +105,7 @@ const myPlugin = bimdataViewer.registerPlugin({
});
```
-
+
:::tip
Checkout [the example about the GUI Layout](../examples/gui_layout.html) for practical application.
@@ -115,7 +115,7 @@ Checkout [the example about the GUI Layout](../examples/gui_layout.html) for pra
The [**Context Menu**](../reference/context_menu.html) and the [**Keyobard Shortcuts**](../reference/keyboard_shortcuts.html) can be personalized using [**Plugins**](../reference/plugin.html).
-
+
Both of them take into account the context of the request. In this way, it is possible to launch a specific action in a particular [**Window**](../reference/window.html) when a keyboard key is pressed while the mouse is hovering that [**Window**](../reference/window.html). In the same way, it is possible to add to the [**Context Menu**](../reference/context_menu.html) only a list of commands specific to the place where the click was made.
@@ -221,8 +221,8 @@ A good image to see the difference between the bounds of the [`localContext`](..
- 
+ 
+ 
+ 
+ 
\ No newline at end of file
+
\ No newline at end of file
diff --git a/src/viewer/reference/native_plugins.md b/src/viewer/reference/native_plugins.md
index b4d7fcd..0557f09 100644
--- a/src/viewer/reference/native_plugins.md
+++ b/src/viewer/reference/native_plugins.md
@@ -54,7 +54,7 @@ The BCF plugin will be useless if BCF Manager is not enabled.
The Drawing Tools plugin allows to enrich plans from the [**viewer plan**](#viewer-plan) with drawings. Drawings can be predefined shapes like lines, arrows, circles or rectangles, free hand drawings or texts. Except for texts, the line width and the color can be customized for each drawing. Once created, the drawings are stored on the BIMData API. It is possible to move or delete drawings using the corresponding tools (pointer / eraser). It is also possible to edit the text drawing by clicking on them while the text tool is active. Once the input is active, the font size and the text content can be changed.
-The Drawing Tools plugin is disabled by default. To enable it, add the following entry into the `plugins` property object of the [`makeBimdataViewer`](#native-plugins) function:
+The Drawing Tools plugin is disabled by default. To enable it, add the following entry into the `plugins` property object of the [`makeBIMDataViewer`](#native-plugins) function:
```js
const viewer = makeBIMDataViewer({
diff --git a/src/viewer/reference/plugin.md b/src/viewer/reference/plugin.md
index 5192efb..20a30cb 100644
--- a/src/viewer/reference/plugin.md
+++ b/src/viewer/reference/plugin.md
@@ -67,7 +67,7 @@ A plugin component is a [Vuejs 3.x component](https://vuejs.org/guide/essentials
By default, a plugin component is displayed on the window content. (the orange area on the image below)
-
+
## Setup