diff --git a/docs/bim-guide/README.md b/docs/bim-guide/README.md index 1674a5eaad..84f11880b8 100644 --- a/docs/bim-guide/README.md +++ b/docs/bim-guide/README.md @@ -1,6 +1,6 @@ --- sidebar_navigation: - title: BIM Guide + title: BIM guide priority: 975 description: User guide for the OpenProject BIM Edition. robots: index, follow @@ -26,7 +26,7 @@ On top of the general project management functionalities, OpenProject BIM enable OpenProject BIM Edition provides powerful features particular designed for the needs of construction industry. Please choose the topic you want to learn more about. -## IFC Viewer +## IFC viewer Upload your IFC building models and show them directly in the internet browser, without any additional software. @@ -34,7 +34,7 @@ Details: [IFC-Viewer](ifc-viewer) -## BIM Issue Management +## BIM issue management Create tasks directly connected to your building model, import tasks or export tasks from any other BIM application. @@ -42,7 +42,7 @@ Deails: [BIM Issue Management](bim-issue-management) -## Revit Addin +## Revit add-in Stay always connected to OpenProject in realtime, show and create tasks while you're working in the Revit, using the Revit Addin. @@ -72,13 +72,13 @@ You found a bug? Please [report it](../development/report-a-bug) to our [OpenPro -### Can OpenProject features be used within the OpenProject BIM Edition? +### Can OpenProject features be used within the OpenProject BIM edition? Yes, you are able to use all known features. Within our BIM Edition you get the full functionality and additionally some features only for the building industry. -### Is it possible to switch my existing OpenProject Installation to the BIM Edition? +### Is it possible to switch my existing OpenProject installation to the BIM edition? Yes, an existing OpenProject on-premises (self-hosted) installation can easily be switched to the BIM Edition without losing your settings and projects. @@ -86,19 +86,19 @@ In our [Installation & Upgrade Guide](../installation-and-operations/changing-to -### Is OpenProject BIM compatible to other BIM Software? +### Is OpenProject BIM compatible to other BIM software? Yes of course. We are of the opinion that the full potential of the BIM method only works through collaboration and the exchange of information (openBIM). For this reason we support the open BCF XML Standard. You are able to import and export all created BCF and stay interoparable with any other BCF software. -### Why do I need a Revit Add-In? +### Why do I need a Revit add-in? You don't need it, but it makes your BIM Issue Management much easier. The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other BCF software. -### Are there any System Requirements for the Revit Add-In? +### Are there any system requirements for the Revit add-in? The OpenProject Revit Add-In does not have any special system requirements. Only a supported [version of Autodesk Revit](./revit-add-in/#system-requirements) must be installed. @@ -114,7 +114,7 @@ The OpenProject BIM Addin for Revit supports the following versions: -### Is it possible to use OpenProject BIM without REVIT? +### Is it possible to use OpenProject BIM without Revit? Yes! The Revit Add-In is just additional to the OpenProject BIM core functionality. It's still possible to import and export BCF XML as you like and stay interoparable with any other Software for BIM Issue Management. @@ -146,7 +146,7 @@ There are many potential reasons why you can't see your building model. Please c -### Where to find the Version of my Revit AddIn? +### Where to find the version of my Revit add-in? To see which version of the Revit AddIn you are currently using, navigate to the OpenProject tab in the Revit taskbar and open the settings. Here you can see which version you are currently using. diff --git a/docs/bim-guide/bim-issue-management/README.md b/docs/bim-guide/bim-issue-management/README.md index 09c88e0cae..be8487eadf 100644 --- a/docs/bim-guide/bim-issue-management/README.md +++ b/docs/bim-guide/bim-issue-management/README.md @@ -1,19 +1,19 @@ --- sidebar_navigation: - title: BIM Issue Management + title: BIM issue management priority: 200 description: How to use OpenProject BIM Issue Management. robots: index, follow keywords: BIM, BCF, IFC, BIM Issue Management, BCF-Management --- -# BIM Issue - Management (BIM feature) +# BIM issue management (BIM feature) Within the *BCF-Module* you are able to manage *BIM Issues (BCF)*. All BIM Issues get stored as BCFs centrally and are available to every team member in real time. Below you find the most important features how to use the BCF Module to create, inspect and manage issues. -## What is a BIM Issue? +## What is a BIM issue? A BIM Issue is a special kind of work package to communicate directly within the building model. It supports you to solve problems and coordinate the planning phase in a building project. @@ -23,7 +23,7 @@ OpenProject BIM supports the standard of the ***BIM Collaboration Format (BCF)** -## Create a BIM Issue +## Create a BIM issue To create a BIM Issue you don't have to configure a new type of work package. Every work package (e.g. Task, Issue, Milestone, … ) can become a BIM Issue only by adding a viewpoint to the work package. @@ -42,7 +42,7 @@ Then, navigate to the BCF module in the project navigation. -### Create a new BIM Issue +### Create a new BIM issue To create new BIM Issues, you have to open the Model - Viewer first and create the view you want to save within the BIM Issue (e.g. zoom, [rotate](../ifc-viewer/#how-to-rotate-the-building-model), [slice](../ifc-viewer/#how-to-slice-the-building-model), [select](../ifc-viewer/#how-to-select-elements), [hide](../ifc-viewer/#show-or-hide-models-or-elements-via-model-tree), … ). @@ -86,14 +86,14 @@ Now open the **work package Details** by double click on the work package ("my f -## BIM Issue Handling (Details View) +## BIM issue handling (details view) The handling of BIM Issues is similar to the handling of work packages (including configuration of the attribute). To jump to a viewpoint of an existing BIM Issue the model viewer has to be activated (visible in the center of your screen) or you have to open the detail view of the work package. -### Jump to a Viewpoint with the Details View +### Jump to a viewpoint with the details view If the Model viewer isn't shown yet, open the Detail - view of the BIM Issue and follow the Cube symbol of the preview. Now the model viewer opens and the viewpoint of the BIM Issue will be displayed. @@ -103,7 +103,7 @@ If the Model viewer isn't shown yet, open the Detail - view of the BIM Issue and -### Switch between different Viewpoints +### Switch between different viewpoints After creating multiple BIM Issues you are able to jump between different viewpoints easily. The "Viewer and Cards" - Mode shows all of your BIM Issues. With a single click at the preview of the BIM Issue, the model viewer changes immediately. @@ -113,14 +113,14 @@ After creating multiple BIM Issues you are able to jump between different viewpo -### Configuration of BIM Issues +### Configuration of BIM issues To create BIM Issues you don't have to configure additional work package types. Every existing work package can become a BIM Issue by adding a viewpoint. Before you can add a viewpoint to a work package, this work package must be enabled for viewpoints in the system administration. -## View and Find BIM Issues (Cards and List View) +## View and find BIM issues (cards and list view) ### Overview @@ -131,7 +131,7 @@ You can switch between different View modes within the OpenProject toolbar. Just -### Viewer and Cards +### Viewer and cards ![Viewer and Cards](Viewer_and_Cards.png) @@ -143,7 +143,7 @@ To view only the detail view of the BIM issue without resetting the current view -### Cards Mode +### Cards mode Within the cards view you are not able to jump directly to a viewpoint. First you have to open the details view by using the "information icon" or the work package number ("#…") at the card. There you can find the "Cube" which leads you to the viewpoint within the appearing model viewer. @@ -154,7 +154,7 @@ Within the cards view you are not able to jump directly to a viewpoint. First yo -### Viewer and Table +### Viewer and table To open the BIM Issue in this mode just click at the work package in the table. By double click at the BIM Issue the viewpoint will be shown and the details will appear. The details of each work package can be shown without changing the current view of the model by single click at the work package ID. @@ -175,7 +175,7 @@ Within the table view you are not able to jump directly to a viewpoint. First yo -## Filter BIM Issues +## Filter BIM issues You are able to filter BIM Issues by using the filter button in the **OpenProject toolbar**. The filter is usable in every view. @@ -188,7 +188,7 @@ You are able to filter BIM Issues by using the filter button in the **OpenProjec -## BIM Issues in Workpackage Module +## BIM issues in workpackage module BIM Issues are also listed in the workpackage module. This supports you to manage your building project in the best way and get an overview of all issues. To separate work packages and BIM Issues we created a new filter which enables you to filter BIM Issues. @@ -199,13 +199,13 @@ BIM Issues are also listed in the workpackage module. This supports you to manag -## Import and Export BCF Issues using BCF +## Import and export BCF issues using BCF Within the BCF module you are able to upload BIM Issues which are created within other software and download already existing files to manage them within other BIM project management solutions. Just Click on the ***"Import"-Button*** or ***"Export"-Button*** within the OpenProject Toolbar. -### Import of Attributes +### Import of attributes After importing a BCF Issue (or multiple Issues at the same time) from another software, OpenProject will match existing attributes and types of the work package. @@ -242,7 +242,7 @@ After a successful matching of the attributes the topics will be displayed in Op -### Outdated BCF Issues +### Outdated BCF issues If there are more recent changes to the work package in OpenProject than in the imported BCF ("ModifiedDate"), the import will be rejected. diff --git a/docs/bim-guide/ifc-viewer/README.md b/docs/bim-guide/ifc-viewer/README.md index 9b58382404..dbc73d6ac3 100644 --- a/docs/bim-guide/ifc-viewer/README.md +++ b/docs/bim-guide/ifc-viewer/README.md @@ -7,7 +7,7 @@ robots: index, follow keywords: BIM, BCF, IFC, Viewer --- -# IFC-Viewer (BIM feature) +# IFC viewer (BIM feature) OpenProject BIM includes a very powerful IFC viewer to show and interact with building models in 2D & 3D. @@ -29,7 +29,7 @@ The BCF Module has included a very powerful IFC viewer. Here is a short overview -## Import and Export IFC Models +## Import and export IFC models Within the BCF module you are able to manage your IFC files. You are able to upload new building models and download already existing files. Just Click on the ***"IFC-Models"-Button*** within the OpenProject Toolbar. @@ -82,11 +82,11 @@ To rotate the IFC model you either left-click on the building viewer and ***rota -## IFC-Viewer toolbar +## IFC-viewer toolbar The IFC-Viewer toolbar has many functions which are described below. The user actions all relate to the viewer and can be started by clicking on the button. -### Reset-View +### Reset view ![Reset View](reset-view.png) @@ -96,7 +96,7 @@ If your building model (or objects within the model) is rotated, zoomed or cut a -### 2D / 3D View +### 2D / 3D view ![2D View](2-d-view.png) @@ -106,7 +106,7 @@ If your building model can easily be shown in 2D or 3D. This function is very po -### Orthographic View +### Orthographic view ![Orthographic Button](orthographic-button.png) @@ -114,7 +114,7 @@ The default behavior of the OpenProject BIM Model Viewer is a perspective view. ![Orthographic View](orthographic-view.png) -### Fit View +### Fit view ![Fit View Button](fit-view-button.png) @@ -124,7 +124,7 @@ This function allows you to reset the current zoom level and the position of the -### First Person Perspective +### First person perspective ![First Person Button](first-person-button.png) @@ -172,7 +172,7 @@ To select elements within the building model, you have to activate the selection -## Show Properties +## Show properties You are able to see the basic properties of each element (e.g. the UUID) within OpenProject BIM. After using the "information" buttion a new tab named "Properties" will appear. @@ -198,7 +198,7 @@ In order to inspect the information for individual objects, you have to use the -## Show or Hide elements via viewer +## Show or hide elements via viewer There are two options to hide elements via viewer. The **first possibility** is to use the ***IFC-viewer toolbar***. Within the toolbar you will find the **"hide-button"** @@ -226,7 +226,7 @@ Sometimes it is helpful to see elements in context to other elements but a good -## Show Elements in Model Tree +## Show elements in model tree To be sure if you hide or select the element you want you are able to jump to this element in the IFC Model tree. @@ -238,7 +238,7 @@ All you have to do is open the context menu on the desired element and select th -## Show or Hide models or elements via model tree +## Show or hide models or elements via model tree If you have uploaded several IFC models of one building (e.g. one for each discipline - Architecture, Structural & MEP) and want to have a look at a single model or just want to hide specific elements, you are able to hide them by changing the status of the ***checkbox within the model tree.*** diff --git a/docs/bim-guide/revit-add-in/README.md b/docs/bim-guide/revit-add-in/README.md index 5bbff9dbea..96ecd3ecd0 100644 --- a/docs/bim-guide/revit-add-in/README.md +++ b/docs/bim-guide/revit-add-in/README.md @@ -1,13 +1,13 @@ --- sidebar_navigation: - title: Revit Add-in + title: Revit add-in priority: 100 -description: How to use the OpenProject BIM - Revit AddIn. +description: How to use the OpenProject BIM - Revit add-in. robots: index, follow keywords: BIM, BCF, IFC, Viewer --- -# Revit Add-In (BIM feature) +# Revit add-in (BIM feature) The *OpenProject Revit Add-In* allows you to use the open source project management software *OpenProject BIM* directly within your Autodesk Revit environment. It lets you create, inspect and manage issues right in the moment when you can also solve them - when you have your Revit application fired up and the relevant BIM models open. Issues get stored as BIM Issues centrally and are available to every team member in real time - thanks to our browser based IFC viewer even to those team members without expensive Revit licenses. No BCF XML import/export is needed. However, you still can import and export BCF XML as you like and stay interoparable with any other software for BIM Issue Management. @@ -20,7 +20,7 @@ To download the latest version (v2.2.3) of our OpenProject Revit AddIn click her -## Before Usage +## Before usage Please check the following steps before using the OpenProject BIM Edition. @@ -36,7 +36,7 @@ If you can answer all questions with "yes" you are ready to start using our Revi -### System Requirements +### System requirements The **OpenProject Revit AddIn** does not have any special system requirements. Autodesk Revit must be installed. The following versions of Revit are supported: @@ -46,7 +46,7 @@ The **OpenProject Revit AddIn** does not have any special system requirements. A -### Download the Installer +### Download the installer To download the setup application for the **OpenProject Revit AddIn**, click here: [DOWNLOAD](https://github.com/opf/openproject-revit-add-in/releases/download/v2.3.3/OpenProject.Revit.exe) @@ -87,7 +87,7 @@ After you have downloaded the file, please run it to start the installation proc -## How to update from an Earlier Version? +## How to update from an earlier version? If you already have an earlier version installed, simply follow the same steps as for a new installation ([How to install?](#how-to-install)). The existing **OpenProject Revit AddIn** will be updated. @@ -113,7 +113,7 @@ The settings will appear in a new tab. Within this tab you have to insert your o -## How to select a Project +## How to select a project After connecting your OpenProject BIM instance you are able to start working with your BCF Tasks within Revit. Firstly you have to open the **OpenProject Tab** in the taskbar and start the application. @@ -127,7 +127,7 @@ After starting the application a new tab will be created and you are able to sel -## Working with BIM Issues +## Working with BIM issues To work with BIM Issues, please open our AddIn and navigate to our BCF Module. @@ -167,7 +167,7 @@ The handling of BIM Issues within Revit is similar to OpenProject BIM. There are -## Synchronize Tasks between Revit and OpenProject +## Synchronize tasks between Revit and OpenProject OpenProject BIM and Revit automatically synchronize all BIM work packages. You don't have to pay attention to anything else and you can manage your entire project directly in OpenProject. Whatever you do, users of OpenProject BIM Edition will see any changes in the browser as well. @@ -183,7 +183,7 @@ OpenProject BIM and Revit automatically synchronize all BIM work packages. You d -## How to uninstall the OpenProject Revit AddIn? +## How to uninstall the OpenProject Revit add-in? To remove the **OpenProject Revit AddIn** remove the AddIn like any other AddIn from Revit. First close any running instance of Revit. Then you'll have to enter the directory `C:\ProgramData\Autodesk\Revit\Addins\`. There you must delete the file `OpenProject.Revit.addin` and the folder `OpenProject.Revit`. After a restart of Revit, the **OpenProject Revit AddIn** is no longer available.