Add start of 'profiles' chapter with a glossary

This commit is contained in:
Ghostkeeper 2020-04-24 16:53:56 +02:00
parent e6a8d3b88e
commit 2fc98eda8a
No known key found for this signature in database
GPG key ID: D2A8871EE34EC59A
2 changed files with 13 additions and 1 deletions

View file

@ -17,4 +17,5 @@ This documentation will touch on the inner workings of Uranium as well though, d
Index Index
---- ----
The following chapters are available in this documentation: The following chapters are available in this documentation:
* [Repositories](repositories.md) * [Repositories](repositories.md): An overview of the repositories that together make up the Cura application.
* [Profiles](profiles/profiles.md): About the profile system of Cura.

11
docs/profiles/profiles.md Normal file
View file

@ -0,0 +1,11 @@
Profiles
====
Cura's profile system is very advanced and has gotten pretty complex. This chapter is an attempt to document how it is structured.
Glossary
----
The terminology for these profiles is not always obvious. Here is a glossary of the terms that we'll use in this chapter.
* **Profile:** Either an *instance container* or a *definition container*.
* **Definition container:** Profile that's stored as .def.json file, defining new settings and all of their properties. In Cura these represent printer models and extruder trains.
* **Instance container:** Profile that's stored as .inst.cfg file or .xml.fdm_material file, which override some setting values. In Cura these represent the other profiles.
* **[Container] Stack:** A list of profiles, with one definition container at the bottom and instance containers for the rest. All settings are defined in the definition container. The rest of the profiles each specify a set of value overrides. The profiles at the top always override the profiles at the bottom.