diff options
| author | Ghostkeeper <rubend@tutanota.com> | 2020-04-24 17:53:56 +0300 |
|---|---|---|
| committer | Ghostkeeper <rubend@tutanota.com> | 2020-04-24 17:53:56 +0300 |
| commit | 2fc98eda8a6bbb4d812c972203364dbad87d7b51 (patch) | |
| tree | 92a21b11dac7a37e676691f73571a0e6c3ed6cdb /docs | |
| parent | e6a8d3b88e391c70d7ab17e5d0cc169de7ed97c0 (diff) | |
Add start of 'profiles' chapter with a glossary
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 3 | ||||
| -rw-r--r-- | docs/profiles/profiles.md | 11 |
2 files changed, 13 insertions, 1 deletions
diff --git a/docs/index.md b/docs/index.md index bb59a5299c..8ca834cb2f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,4 +17,5 @@ This documentation will touch on the inner workings of Uranium as well though, d Index ---- The following chapters are available in this documentation: -* [Repositories](repositories.md)
\ No newline at end of file +* [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.
\ No newline at end of file diff --git a/docs/profiles/profiles.md b/docs/profiles/profiles.md new file mode 100644 index 0000000000..be9e4580b4 --- /dev/null +++ b/docs/profiles/profiles.md @@ -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.
\ No newline at end of file |