Add templates docs #1703
Add templates docs #1703
Conversation
There was a problem hiding this comment.
I think it's a good start and pushed some minor adjustments. Here are some additional comments.
The updates to the TMX Map Format page are not exactly following the structure of the document, but I understand it's a bit weird with the elements actually being in a separate file. I should probably adjust this document to mention external tileset files more explicitly as well. In any case, please don't forget to update the "Can contain" sections of the map element and to add this line to the templategroup and template elements.
docs/manual/using-templates.rst
Outdated
| =============== | ||
|
|
||
| Any created object can be saved with all of its properties as a template, this | ||
| template can be used to create copies of the object on object layers. This can |
There was a problem hiding this comment.
I think it's confusing to talk about "copies" here, since the template system specially avoids copying, which is one of the main advantages over using the already available copy-paste mechanism. Maybe we could make it:
Any created object can be saved as a template. These templates can then be instantiated elsewhere, as objects that inherit their properties.
docs/manual/using-templates.rst
Outdated
| Creating Templates | ||
| ------------------ | ||
|
|
||
| A template can be create by right clicking on any object in the map and |
docs/manual/using-templates.rst
Outdated
| template group to save the template to. If the object already has a name the | ||
| name field will be auto-filled with it. | ||
|
|
||
| Template groups can be created from the new template group button in the |
There was a problem hiding this comment.
I think the button name should be capitalized "the New Template Group button".
docs/manual/using-templates.rst
Outdated
| name field will be auto-filled with it. | ||
|
|
||
| Template groups can be created from the new template group button in the | ||
| templates view or from the new template dialog. |
There was a problem hiding this comment.
Capitalization of named things: "Templates view or from the New Template dialog"
docs/manual/using-templates.rst
Outdated
| The templates View | ||
| ------------------ | ||
|
|
||
| Working with templates is done through the templates view. The templates view |
docs/manual/using-templates.rst
Outdated
| ----------------- | ||
|
|
||
| Selecting a template will load an editable preview in the templates view and | ||
| will load the template's properties into the properties view where they can be |
There was a problem hiding this comment.
I think "show" would be a better term than "load" here.
Also "the Properties view".
docs/manual/using-templates.rst
Outdated
| will load the template's properties into the properties view where they can be | ||
| edited. | ||
|
|
||
| All template instances are linked to the base template, so all edits will be |
There was a problem hiding this comment.
"linked to their template"? I'd prefer to avoid additional terms like "base template" when possible.
docs/manual/using-templates.rst
Outdated
| Detaching Template Instances | ||
| ---------------------------- | ||
|
|
||
| Detaching a template instance will disconnect it from the base template, so any |
There was a problem hiding this comment.
"disconnect it from its template"
thabetx
force-pushed
the
templates-docs
branch
from
035a825
to
92da668
Compare
thabetx
force-pushed
the
templates-docs
branch
from
92da668
to
7c47b51
Compare
|
I also feel that the format part is different from the rest of the document due to external referencing. |
I reused some parts from the 1.1 alpha release post and reused the gifs from forum templates post.
I'm not sure if the reference part is clear enough, so I put an example template group.