Skip to content

getting-started/glossary updates #307

Description

@ant-tar

What needs to be improved?

https://docs.modx.com/current/en/getting-started/glossary

After working on updating system variables, the following idea came to my mind - it would be great to have some kind of "starting point" where original terms used in the system would be. We have Glossary, but it seems many terms don't exist at all, while others require renovation/updating.

As soon as it is updated, it'll be good to update accordingly, for example, the Russian glossary (and other translations). It is very useful to have it at hand when you are doing translations and there is a double interpretation - I also saw in Crowdin's lexicons that one and the same entity has similar but still different names.

What I would like to do:

  1. Alphabetical order
  2. Links from term to appropriate documentation page (the title itself could be a link .. or use something like "more..." )
  3. Add more clickable synonyms to Glossary (they were) - example: getting-started/glossary#document-identifier
  4. More links inside the Glossary page itself, for example:

Content Type
Sets the extension, mime-type and binary setting for any Resource. The same for "Extension"(exists) and Mime-type(absent, can be added.)

"Resource" here should be the link to anchor below for "Resource" term

  1. Add more general terms to Glossary that are also found in the documentation (Session, Database, etc.) so that ordinary user does not need to look for the definition elsewhere.
  2. for all Glossary terms in the documentation use the naming with a capital letter - Chunk, Template, Installer, etc.(this is observed mostly in the English version, but is lost in the Russian version), at the beginning of the documentation (or the section "see also") provide such terms with a link to the glossary and / or corresponding documentation page.
  3. here is a list of some terms that I would also like to add / actualize (this is what I came across in the documentation):
  • - Dispatcher/ Installer (syns for Package Management)
  • - Authentication
  • - Username
  • - Database
  • - Session
  • - Cookie files
  • - Cache
  • - Media Browser / MODX Browser / File Manager- btw it seems we have no page for it at all!
  • - File System
  • - Content Type
  • - Resource tree
  • - FURLs
  • - request id parameter / request alias parameter
  • - Media Source / File Source
  • - editing TV-fields in the Resource.
  • - User
  • - Form Customization
  • - Controller
  • - FC Sets
  • - User's Primary Group
  • - Container
  • - Menu (main, user menu)
  • - URI
  • - Error log (system log, log)
  • - TV (syn for Template Variables)
  • - use_weblink_target - what is the Target of the weblink?
  • - Folder and/ or directory?
  • - Static elements
  • - Property
  • - Object
  • - SPF
  • - DMARC
  • - cURL
  • - Sockets
  • - Class
  • - Object
  • - Checkbox, Selector, Multi selector(should we explain some frequent HTML elements as well)?
  • - Hooks
  • - Prehooks
  • - Processor file
  • - Snippet
  • - Plugin
  • - System events
  • - Connector
  • - Primary key
  • -Parent resource
  • -Child resource
  • -Lexicon Management(+separate page)
    ....to be continued....

I think it is important to do this first since the updating of any other pages should go with an eye to the Glossary. I would be glad to receive your comments. Ready to start soon. @Mark-H @Ibochkarev

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions