Skip to content
This repository has been archived by the owner on May 3, 2021. It is now read-only.

Latest commit

 

History

History
41 lines (30 loc) · 2.07 KB

README.md

File metadata and controls

41 lines (30 loc) · 2.07 KB

IFC 4.3 Documentation server

This code has been moved to https://github.com/buildingSMART/IFC4.3.x-development/tree/master/server

Introduction

This repository illustrates a workflow for collaborative editing of the IFC Documentation. The Markdown documents are taken from https://github.com/buildingSMART/IFC4.3.x-development/tree/master/docs

  • Enable collaborative editing by means of the Github interface
  • Enable quick edits without bespoke software by means of the Github interface
  • Embed a powerful syntax for generating schema diagrams with automatic layout
  • Create interactive diagrams in which the entities are clickable
  • Ensure typographic consistency by using the limited but powerful Markdown syntax
  • Clean-up the invalid existing .html documentation files

Fully functional and consistent HTML documentation is automatically generated from the Markdown files.
The full generated documentation can be accessed at http://ifc43-docs.aecgeeks.com/

Diagrams

One novel feature of this documentation system is the ability to directly edit illustrative schema diagrams using a text-based notation. For this purpose Graphviz is used. The Graphviz DOT definition language is automatically enriched with colour conventions derived from the IFC schema.

For example, the IfcWorkPlan instantiation diagram can be included and edited in the MD files and then be visible in the related HTML page. Below is the Graphviz definition of this figure. The user's input overwrites the automatic settings. This can be verified with the IfcProject node on the HTML diagram, whose link pointing to Building Smart website replaces the link to the entity's HTML page.

The interactive SVG diagram can be seen on the generated HTML page here http://ifc43-docs.aecgeeks.com/IFC/RELEASE/IFC4x3/RC1/HTML/lexical/IfcWorkPlan.htm

Dependencies

  • Flask, gunicorn: http server and API
  • Graphviz, pydot: diagram layout
  • solr, pysolr: search
  • supervisord: process control
  • Docker: container
  • Python-Markdown: document conversion
  • Beautifulsoup4: HTML document post processing