[Diction] Title Naming Conventions

The title naming conventions are designed to standardize page titles across the Wiki, making it easier for readers to accurately locate content through the search bar.

Each page title should follow the format [Tag] {Title}. Here, Tag is a short, capitalized keyword enclosed in square brackets, indicating the page’s category or topic summary. To ensure clear categorization, use the Tags listed on this page whenever possible instead of creating custom ones (If you do need to use a custom tag, place it at the end of the tag list). Multiple tags are allowed, with the main tag placed before sub-tags, like [MainTag][SubTag] This Is A Title.

Titles should follow English title capitalization rules, and be as concise and precise as possible. Short phrases are preferred over full sentences. For pages under the [Device] tag, the title should be the name of the device.

We define the following Tags:

  • [Navigation]: Used for organizing tables of contents, indexes, and navigation pages to help users quickly locate content.
  • [Device]: Introduces various devices, including their functions, parameters, and usage. The title should be the device name.
  • [Tutorial]: Offers systematic how-to guides for learning skills or workflows step-by-step.
  • [GUI]: Focuses on software-related topics, such as settings, panels, and user interface operations.
  • [Macro]: Covers the creation and usage of macros.
  • [Bluemap]: Covers the usage of blueprints.
  • [Code]: Introduces the use of Code devices, including interface documentation.
  • [Idioms]: Documents typical use cases, best practices, and conventional workflows to aid in understanding common approaches.
  • [Sundries]: A flexible tag for miscellaneous content that doesn’t fit other categories. Topics should still remain relevant and concise.

Tags for Wiki contributors and internal development include:

  • [Diction]: Defines writing conventions, terminology usage, and stylistic guidelines.
  • [Discussion]: Records drafting processes, design ideas, and community discussions. Sub-tags are recommended to clarify the topic, e.g., [Discussion][Device] Some Discussion About Perlin Noise.
  • [Announcement]: Used for important Wiki-related announcements, such as current plans or official statements. Content should reflect community consensus.
1 Like

This is just a suggestion for now, and the specific implementation method still needs community discussion.

1 Like