IEEE.org     |     IEEE Xplore Digital Library     |     IEEE Standards     |     IEEE Spectrum     |     More Sites

Commit 6bd2f0ab authored by Tobias Wenzel's avatar Tobias Wenzel
Browse files

Update README.md

parent 71ae4482
......@@ -13,15 +13,11 @@ A DocuBricks documentation of a hardware **project** is characterised by a hiera
Every brick contains the following documentation sections:
Brick overview (description)
Copyright (License and author; inherited from higher bricks if not specified)
Components (**Function**s of the brick’s hardware and their implementations. **Implementation**s are references to other more specialised bricks or parts from the “bill of materials”; bottom level bricks can only contain references to parts)
Assembly instructions (stepwise instructions with associated media files)
Custom instructions (such as calibration, testing, safety, user guide, teaching, etc.)
### Brick overview (description)
* Copyright (License and author; inherited from higher bricks if not specified)
* Components (**Function**s of the brick’s hardware and their implementations. **Implementation**s are references to other more specialised bricks or parts from the “bill of materials”; bottom level bricks can only contain references to parts)
* Assembly instructions (stepwise instructions with associated media files)
* Custom instructions (such as calibration, testing, safety, user guide, teaching, etc.)
A part is a resource listed in the bill of materials (BOM), which is needed to assemble or run the project, mainly hardware parts e.g. a screw, digital design files representing a single object e.g. an STL file for 3d printing, specialist tools, or operating software. Each part is defined in the BOM and can contain supplier information, media and their own manufacturing instructions e.g. when the object is made from a digital file or needs simple pre-processing before it is assembled with other parts.
......@@ -32,78 +28,50 @@ The following reader-friendly lists define the elements of the DocuBricks XML fo
#### <**docubricks**> tag for the start of DocuBricks documentation of the project; the brackets are not written in the following definitions
**author** id(string):
**name** (string)
**email** (string)
**orcid** (string)
**affiliation** (string)
* **author** id(string):
* **name** (string)
* **email** (string)
* **orcid** (string)
* **affiliation** (string)
#### **part** id(string):
**name** (string)
**description** (string)
**supplier** (string)
**supplier_part_num** (string)
**manufacturer_part_num** (string)
**url** (string) link to an internet source of the part
**material_amount** (string)
**material_unit** (string)
**media: file(s)** (url) images, videos, CAD files, and more
**manufacturing_instruction: step(s)**: step by step instructions
**description** (string)
* **name** (string)
* **description** (string)
* **supplier** (string)
* **supplier_part_num** (string)
* **manufacturer_part_num** (string)
* **url** (string) link to an internet source of the part
* **material_amount** (string)
* **material_unit** (string)
* **media: file(s)** (url) images, videos, CAD files, and more
**media: file(s)** (url)
* **manufacturing_instruction: step(s)**: step by step instructions
* **description** (string)
* **media: file(s)** (url)
#### **brick** id(string):
**name** (string)
**abstract** (string)
**long_description** (string)
**notes** (string)
**media: file** (url)
**license** (string)
**author(s)** (**id**(string))
**function(s)** (**id**(string)):
**description** (string) name of the function
**implementation(s)** (**type**(“brick” or “part”), **quantity** (int) nr. needed pieces, **id**(string) of brick or part respectively
**assembly_instruction: step(s)**: step by step instructions
**description** (string)
**media: file(s)** (url)
**component(s)** (**quantity**(int), **id**(string) of function) local reference to functions in the brick needed as component in this assembly step
**instruction(s) name**(string): **step(s)**: other step by step instructions of custom type e.g. safety, testing, calibration, user_manual, improvement_suggestions, etc.
**description** (string)
**media: file(s)** (url)
**component(s)** (**quantity**(int), **id**(string) of function) local reference to functions in the brick needed as component in this assembly step
* **name** (string)
* **abstract** (string)
* **long_description** (string)
* **notes** (string)
* **media: file** (url)
* **license** (string)
* **author(s)** (**id**(string))
* **function(s)** (**id**(string)):
* **description** (string) name of the function
* **implementation(s)** (**type**(“brick” or “part”), **quantity** (int) nr. needed pieces, **id**(string) of brick or part respectively
* **assembly_instruction: step(s)**: step by step instructions
* **description** (string)
* **media: file(s)** (url)
* **component(s)** (**quantity**(int), **id**(string) of function) local reference to functions in the brick needed as component in this assembly step
* **instruction(s) name**(string): **step(s)**: other step by step instructions of custom type e.g. safety, testing, calibration, user_manual, improvement_suggestions, etc.
* **description** (string)
* **media: file(s)** (url)
* **component(s)** (**quantity**(int), **id**(string) of function) local reference to functions in the brick needed as component in this assembly step
#### </ **docubricks** >
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment