Properties

Properties in Gramax are additional parameters for articles that are configured within a catalog and help structure content and generate reports.

You can display properties in an article on the documentation portal and make them searchable for readers. To do this, enable the Show to readers option in the properties editor.

For example, you can use properties for task management, where each article represents a task with specific team members, reviewers, and statuses.

Property Types

  • Numeric. Stores a numerical value. Example: Estimate — used to indicate the number of days required to complete a task.

  • Flag. Represents a Yes/No or tag on an article. Example: Important — marks articles/tasks critical for a release.

  • Single-Select List. A dropdown with a list of values where only one can be selected. Example: Assignee — contains team members' names; one person is assigned.

  • Multi-Select List. A list where multiple values can be selected. Example: Subsystem — lists components affected by a new task, allowing multiple selections.

  • Date. Captures the current date. Example: Create date — records the task's creation date.

  • Text. Allows free-form text input. Example: Comment — used for additional notes or context about the task.

Known Limitations

  • Renaming Properties or Values: It’s not possible to rename a property or its value directly. You’ll need to delete the existing property or value and recreate it with the new name.