Skip to content

Tagging

Jump to bottom
sujato edited this page Jun 16, 2026 · 1 revision

A Tagger creates tags for the root text. They can view the root text and any translation, but cannot edit them.

how to create and apply tags

The Tagger must first be authorized to create and apply tags. Then they can create a list of tags on /tags. This can be edited or deleted at any time. Each tag consists of three elements.

  • tag: this is used for processing, URLs, etc. It must be
    • lowercase
    • alphanumeric
    • no diacriticals or other fancy characters
    • no punctuation except hyphen
    • no spaces
  • expansion: this is shown to the user. It is a short, readable version of the tag. Eg., the tag “4nt” might expand to “four noble truths”. Keep them lowercase, but you may use spaces, punctuation, etc.
  • definition: a short explanation of the tag concept understandable to general readers. Avoid using Pali or technical language. This definition may be displayed, eg. as a popup or in a list of definitions.

Once the tag list is created, the Tagger may begin adding tags to texts. Only valid tags may be entered.

If the Tagger deletes a tag, all instances of that tag will be deleted from the files. Likewise, if a Tagger edits a tag, all instances will be updated to the new form.

The Tagger may add as many tags as they like per segment in a comma separated list.

In addition, a Tagger can leave remarks on translations to whom they have subscribed, like a reviewer.

things to bear in mind

Tags are meant to help readers find things they may be interested in.

Tags should be semantic, i.e. they refer to a concept, not a term. For example, in Pali there are many words meaning “energy”. A tag allows a reader to see texts on that topic, regardless of whether the underlying term is padhāna, vāyāma, viriya, etc.

Don’t use tags for things that a word search can provide, like proper names, nor for things that are too common, like say the “Buddha”.

Too many tags creates clutter, too few is of limited use. Start with a reasonably-sized list of tags and let it evolve as you go.

Tags go at the start of a passage, not on every occurrence.

Clone this wiki locally