2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00

Updated index.md, added documentation on Part Parameters

This commit is contained in:
eeintech 2020-09-23 16:06:51 -05:00
parent b1feda6c2d
commit e5013d1240
7 changed files with 52 additions and 12 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -28,7 +28,7 @@ InvenTree provides a translation layer for the web interface, this requires effo
### Documentation ### Documentation
Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree.github.io). Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree-docs).
### Donate ### Donate

View File

@ -14,19 +14,19 @@ InvenTree is designed to be lightweight and easy to use for SME or hobbyist appl
InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API. InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API.
InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight sqlite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users. InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight SQLite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users.
## Features ## Features
### Organize Parts ### Organize Parts
Parts are the fundemental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs. Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs.
[Read more...](part/part) [Read more...](part/part)
### Manage Suppliers ### Manage Suppliers
Link parts to multiple suppliers, InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory.
[Read more...](buy/supplier) [Read more...](buy/supplier)
@ -39,12 +39,14 @@ Instantly view current stock for a certain part, in a particular location, or re
### BOM Management ### BOM Management
Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part. Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part.
InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database.
[Read more...](build/bom) [Read more...](build/bom)
### Build Parts ### Build Parts
Consume stock items to make new parts Inventree features a build management system to help you track the progress of your builds.
Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory.
[Read more...](build/build) [Read more...](build/build)

View File

@ -5,5 +5,43 @@ layout: page
## Part Parameters ## Part Parameters
!!! missing "TODO" Part parameters are located in the "Parameters" tab, on each part detail page.
Parameter documentation to be written There is no limit for the number of part parameters and they are fully customizable through the use of parameters templates.
Here is an example of parameters for a Ceramic capacitor:
{% with id="part_parameters_example", url="part/part_parameters_example.png", description="Part Parameters Example List" %}
{% include 'img.html' %}
{% endwith %}
### Create Template
A *Parameter Template* is required for each part parameter.
To create a template, you have two options:
1. navigate to the "Settings" page, click on the "Part" tab and then click on the "New Parameter" button
0. navigate to a specific part detail page, click on the "Parameters" tab, click on the "New Parameters" button then click on the "New Template" button in the newly displayed form.
The `Create Part Parameter Template` form will be displayed:
{% with id="create_parameter_template", url="part/create_parameter_template.png", description="Create Part Parameter Template Form" %}
{% include 'img.html' %}
{% endwith %}
Fill-out the template `Name` (required) and `Units` (optional) fields then click the "Submit" button.
### Create Parameter
After [creating a template](#create-template) or using the existing templates, you can add parameters to any part.
To add a parameter, navigate to a specific part detail page, click on the "Parameters" tab then click on the "New Parameters" button, the `Create Part Parameter` form will be displayed:
{% with id="create_part_parameter", url="part/create_part_parameter.png", description="Create Part Parameter Form" %}
{% include 'img.html' %}
{% endwith %}
Select the parameter `Template` you would like to use for this parameter, fill-out the `Data` field (value of this specific parameter) and click the "Submit" button.
### Parametric Tables
!!! note "Future Feature Proposal"
Allow parts to be filtered using parameters. Narrow down the list of parameters to the parts found in each category.

View File

@ -57,7 +57,9 @@ Parts can have multiple defined [parameters](/part/parameter).
## Variants ## Variants
If a part is a *Template Part* then the *Variants* tab will be visible. [Part templates](/part/template) If a part is a *Template Part* then the *Variants* tab will be visible.
[Read about Part templates](/part/template)
## Stock ## Stock
@ -93,8 +95,7 @@ The *BOM* tab displays the [Bill of Materials](/build/bom) - a list of sub-compo
## Build Orders ## Build Orders
!!! missing "TODO" The *Build Orders* tab shows a list of the builds for this part. It provides a view for important build information like quantity, status, creation and completion dates.
Documentation to be written
## Used In ## Used In
@ -118,8 +119,7 @@ This tab is only displayed if the part is marked as *Purchaseable*.
## Sales Orders ## Sales Orders
!!! missing "TODO" The *Sales Orders* tab shows a list of the sales orders for this part. It provides a view for important sales order information like customer, status, creation and shipment dates.
Documentation to be written
## Tests ## Tests