Skip to content

Commit

Permalink
lint fix
Browse files Browse the repository at this point in the history
  • Loading branch information
as-op committed Apr 29, 2024
1 parent 0e21497 commit 1b63e44
Show file tree
Hide file tree
Showing 342 changed files with 140 additions and 1,853 deletions.
3 changes: 0 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@ The guides for [upgrading](./installation-and-operations/operation/upgrading) ar
* [Configure incoming mails](./installation-and-operations/configuration/incoming-emails)
* [Install custom plugins](./installation-and-operations/configuration/plugins)


## User Guides

Please see our [User Guide pages](./user-guide/) for detailed documentation on the functionality of OpenProject.
Expand All @@ -38,7 +37,6 @@ Please see our [User Guide pages](./user-guide/) for detailed documentation on t

Please see our [Use Cases section](./use-cases/) for detailed how-to guides and step-by-step instruction on how to set up a variety of common cases and views.


## Development

* [Full development environment for developers on Ubuntu](./development/development-environment-ubuntu) and [Mac OS X](./development/development-environment-osx)
Expand All @@ -48,7 +46,6 @@ Please see our [Use Cases section](./use-cases/) for detailed how-to guides and
* [Code review guidelines](./development/code-review-guidelines)
* [API documentation](./api)


## APIv3 documentation sources

The documentation for APIv3 is written in the [OpenAPI Format](https://www.openapis.org/) and its sources are being built from the entry point `openapi-spec.yml`.
1 change: 0 additions & 1 deletion docs/api/apiv3/client-libraries/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ While we cannot endorse or vet the libraries listed below we encourage their cre

If you need help developing a client library you can [contact us](mailto:[email protected]). If you want to have a client library listed in the list below you can again [contact us](mailto:[email protected]) or simply issue a PR with [changes to the source file](https://github.com/opf/openproject/blob/dev/docs/api/apiv3/client-libraries/README.md).


## JavaScript / TypeScript

* [op-client](https://www.npmjs.com/package/op-client): Client library for OpenProject server. Works both on Node.js and browser.
Expand Down
1 change: 0 additions & 1 deletion docs/api/apiv3/example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,6 @@ The value taken for the `href` in a resource value will always be the `self` lin

![work package create schema self link](./wp-create-form-schema-self-link.png)


*The correct combination of `project` and `type` needs to be chosen. Sometimes a type is not available in every project. In that case, the type either can be added to the project in the UI or a different type needs to be chosen for the project. This is why it sometimes makes sense to first send the project within the form body as this will update the `availableValues` listed for `type`*

### Sending the create request
Expand Down
1 change: 0 additions & 1 deletion docs/api/faq/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ That's not possible at the moment. You can only [retrieve](../endpoints/wiki-pag
The API v3 currently does not expose categories via the API.

Please note that categories might change in the future as they have a lot of limitations, e.g. when filtering.

39 changes: 0 additions & 39 deletions docs/bim-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,10 @@ Welcome to the OpenProject user guide for Building Information Modeling (BIM) wi

On top of the general project management functionalities, OpenProject BIM enables construction teams to better plan, communicate and collaborate in their building projects. OpenProject BIM includes a 3D model viewer (IFC viewer), support of the BIM collaboration format (BCF) for BIM issue management, and much more powerful features, e.g. a [Revit integration](revit-add-in).


> **Note**: This guide only covers the specific [BIM features and functionalities of OpenProject](https://www.openproject.org/bim-project-management/). To learn more about the core features for project management of OpenProject (which are included in the BIM edition as well), please visit our [User Guide](../user-guide/).

![BIM Project Management](demo_project_teaser_bim.jpg)



## Overview of all topics regarding the OpenProject BIM edition

OpenProject BIM edition provides powerful features particular designed for the needs of construction industry. Please choose the topic you want to learn more about.
Expand All @@ -29,78 +25,54 @@ Upload your IFC building models and show them directly in the internet browser,

Details: [IFC-Viewer](ifc-viewer)



## BIM issue management

Create tasks directly connected to your building model, import tasks or export tasks from any other BIM application.

Details: [BIM Issue Management](bim-issue-management)



## Revit add-in

Stay always connected to OpenProject in realtime, show and create tasks while you're working in the Revit, using the Revit Add-in.

Details: [Revit Add-in](revit-add-in)



## How to get a free trial

You easily can start a new BIM trial on our [OpenProject BIM website](https://www.openproject.org/bim-project-management/). The have a look at the full description of how to start a new trial installation just follow the Link: [Create trial installation](../enterprise-guide/enterprise-cloud-guide/create-cloud-trial/).



## How to enable the BCF module

The BCF Module and the included IFC viewer can be enabled for every single project. Here you can find the description how to [enable a module](../user-guide/projects/project-settings/modules/) within your ***project settings***.



## Reporting bugs

You found a bug? Please [report it](../development/report-a-bug) to our [OpenProject community](https://community.openproject.org/projects/revit-add-in). Thank you!



## BIM FAQs



### 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?

Yes, an existing OpenProject on-premises (self-hosted) installation can easily be switched to the BIM edition without losing your settings and projects.

In our [Installation & Upgrade Guide](../installation-and-operations/bim-edition/) you can find a description how to switch.



### 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 interoperable with any other BCF software.



### 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 interoperable with any other BCF software.



### 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.



### Which versions of Revit are supported?

The OpenProject BIM Add-in for Revit supports the following versions:
Expand All @@ -109,28 +81,20 @@ The OpenProject BIM Add-in for Revit supports the following versions:
- REVIT 2020
- REVIT 2021



### 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 interoperable with any other Software for BIM Issue Management.



### Are integrations with other BIM software planned?

Yes, we want to develop some other integrations to stay interoperable with other BIM software and make BIM Issue Management with OpenProject BIM much easier.



### How to enable the BCF module

The BCF Module and the included IFC viewer can be enabled or disabled for every single project. Here you can find the description how to [enable a module](../user-guide/projects/project-settings/modules/) within the project settings.

*The BCF Module is an OpenProject BIM Enterprise add-on. Please make sure, that you are already using the OpenProject BIM edition ([switch to the BIM edition](../installation-and-operations/bim-edition/))*



### Why can't I see a building model?

There are many potential reasons why you can't see your building model. Please check out the most common reasons and their solution:
Expand All @@ -141,9 +105,6 @@ There are many potential reasons why you can't see your building model. Please c
- IFC file isn't uploaded yet or is invalid (please check the status of the uploaded file within the [IFC Model management area](ifc-viewer/#import-and-export-ifc-models)).
- IFC file does not have any geometry (please check if your IFC file has some geometry)



### 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.

76 changes: 0 additions & 76 deletions docs/bim-guide/bim-issue-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ keywords: BIM, BCF, IFC, BIM Issue Management, BCF-Management

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?

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.
Expand All @@ -20,8 +18,6 @@ The BIM Issue is not only a description of a problem, the view of the building m

OpenProject BIM supports the standard of the ***BIM Collaboration Format (BCF)***. All BIM Issues which are created within another *Open BIM* Software can be imported to work with this issue within our project management solution.



## 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.
Expand All @@ -35,12 +31,8 @@ BIM-Issues always belong to a project and a building model. Therefore, you first

Then, navigate to the BCF module in the project navigation.



![BCF-Module](OpenProject_BCF_Module.png)



### 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), … ).
Expand All @@ -49,76 +41,49 @@ Click on the **+ Create new work package** and select the type of work package y

![Create a new BIM Issue](create-a-new-BIM-issue.png)



Now you can see a detail view of the new Issue. Describe all necessary information to work on that task and add a viewpoint by clicking on the **"+ Viewpoint"**-Button. Now the current Viewpoint of the Building Model is added to the Issue. After saving your new BIM issue is created.

*Within the viewpoint the current status of your building model is saved. So please check the view before - is there everything shown within the model viewer?*

![Create a viewpoint](Create-a-viewpoint.png)



You also have the option of adding multiple viewpoints to a work package. Rotation, selection and visibility can be changed for every viewpoint to get a better model based communication.

![Adding multiple viewpoints](adding-multiple-viewpoints.png)



### Add a viewpoint to an existing work package

The workflow of adding a viewpoint to an existing work package is similar to creating a new BIM Issue. To switch an existing work package to a BIM Issue just follow the steps:

Open the **BCF-Module** to see the building model.
![BCF Module](bcf_module.png)



Make sure the "Model Viewer & Maps" - View or "Model Viewer & Table" - View is selected within the **OpenProject-Toolbar**.

![Model and work package view](model_maps_view.png)



Now open the **work package Details** by double click on the work package ("my first work-package"). Now you are able to add a viewpoint like it is described above.




## 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

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.

![Display BIM Issue](display_bim_issue.png)





### 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.



![Switch_Viewpoints](Switch_Viewpoints.gif)



### 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)

### Overview
Expand All @@ -127,83 +92,50 @@ You can switch between different View modes within the OpenProject toolbar. Just

![Switch View Mode](Swicht_View_Mode.gif)




### Viewer and cards

![Viewer and Cards](Viewer_and_Cards.png)



The detail view of every work package can be shown by different user actions. To open the viewpoint and see the description in the details view, just double click at the BIM Issue in the card view. After double click your current viewpoint in the model viewer will be reset and the viewpoint of the BIM Issue including all details will be displayed.

To view only the detail view of the BIM issue without resetting the current view of the model, you can click on the work package number ("#…") or the "information icon" on the card.



### 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.

![Cards Mode](Cards-mode.png)






### 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.

![Viewer and Table](viewer-and-table.png)





### Table

Within the table 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 ("#…") or double click at the work package. At the details view you can find the "Cube" which leads you to the viewpoint within the appearing model viewer.

![Table](table.png)






## 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.

![OpenProject Toolbar](OpenProject-toolbar.png)



![Filter BIM Issue](Filter-BIM-Issue.png)




## BIM issues in work package module

BIM Issues are also listed in the work package 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.

![BIM Issues and work packages](bim-issues-and-work-packages.png)






## 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

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.
Expand All @@ -212,8 +144,6 @@ If attributes of the imported BCF Issue can't be matched automatically (because

![Import BCF](import-bcf.png)



**Currently the following attributes can be synchronized and matched:**

- Title & Description
Expand All @@ -229,18 +159,12 @@ If attributes of the imported BCF Issue can't be matched automatically (because
- Due Date
- Comments



After a successful matching of the attributes the topics will be displayed in OpenProject.

![Successful BCF Import](successfull-bcf-import.png)



![Imported BCF Issues](imported-bcf-issues.png)



### 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.
Expand Down
Loading

0 comments on commit 1b63e44

Please sign in to comment.