2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-12 10:15:33 +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

View File

@ -5,5 +5,43 @@ layout: page
## Part Parameters
!!! missing "TODO"
Parameter documentation to be written
Part parameters are located in the "Parameters" tab, on each part detail page.
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
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
@ -93,8 +95,7 @@ The *BOM* tab displays the [Bill of Materials](/build/bom) - a list of sub-compo
## Build Orders
!!! missing "TODO"
Documentation to be written
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.
## Used In
@ -118,8 +119,7 @@ This tab is only displayed if the part is marked as *Purchaseable*.
## Sales Orders
!!! missing "TODO"
Documentation to be written
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.
## Tests