Add common terms to Glossary #42948

Closed
opened 2014-12-18 13:56:41 +01:00 by Greg Zaal · 4 comments
Member

The glossary is a nice place for the user to read and understand what a particular word or phrase means in just a sentence or two. These terms can be referred to easily from anywhere in the docs using (for example):

:term:`Vertex`

which will link to the corresponding entry on the glossary page.

It'd be nice for someone to think up a few common terms to add to the list (e.g. Face, Key Frame, Edge Loop, Manifold...) and complete the existing TODO items there.

It is not meant to be a place for lengthy explanations - if more than a few paragraphs are needed it would be better to create a new document in the appropriate place and link to that. For example:

Key Frame
   A frame which defines the starting or ending points of a transition. See more :doc:`here </animation/introduction>`
The glossary is a nice place for the user to read and understand what a particular word or phrase means in just a sentence or two. These terms can be referred to easily from anywhere in the docs using (for example): ``` :term:`Vertex` ``` which will link to the corresponding entry on the glossary page. It'd be nice for someone to think up a few common terms to add to the list (e.g. Face, Key Frame, Edge Loop, Manifold...) and complete the existing *TODO* items there. It is not meant to be a place for lengthy explanations - if more than a few paragraphs are needed it would be better to create a new document in the appropriate place and link to that. For example: ``` Key Frame A frame which defines the starting or ending points of a transition. See more :doc:`here </animation/introduction>`
Author
Member

Changed status to: 'Open'

Changed status to: 'Open'
Author
Member

Added subscriber: @GregZaal

Added subscriber: @GregZaal
Pep self-assigned this 2015-01-18 04:17:31 +01:00

Added a few terms.

Revision 55.

Regards.

Pep.

Added a few terms. Revision 55. Regards. Pep.

Changed status from 'Open' to: 'Resolved'

Changed status from 'Open' to: 'Resolved'
Pep closed this issue 2015-01-18 11:30:55 +01:00
Sign in to join this conversation.
No Milestone
No project
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender-manual#42948
No description provided.