Glossary Management
At SimpleModeling.org, the operation of the glossary is automated as part of building and utilizing a Body of Knowledge (BoK).
With this mechanism, authors can automatically link terms used in articles to their definitions in the BoK without explicitly setting up the links themselves.
This feature has now been released.
Features
This section introduces the glossary features of this site, including those scheduled for future release.
Term Expansion in Articles
The following features are automatically applied to terms appearing in articles:
-
Automatic insertion of links to glossary entries
-
Tooltip information via the
titleattribute -
Parenthetical supplementary information after terms (planned)
-
Acronym expansion (e.g., CBD → CBD (Component-Based Development))
-
Japanese-English annotations (e.g., 可用性 → 可用性 (Availability))
-
-
Automatic display of term lists and definitions at the end of articles (planned)
Backlinks from Glossary Pages
Each glossary page will display links to all articles that use the respective term. (planned)
Display Style
The following styles are applied to term links within the main text:
-
In normal state: bold black text that blends naturally into the body text
-
On hover: red text and pointer cursor to visually indicate a link
This ensures smooth navigation without visual clutter, even when all terms are linked.
Glossary as a Model
In technical documentation, defining terms is critically important.
Since the meaning of terms often varies depending on the field and the reader’s background, their definitions should be clarified whenever possible to prevent misunderstandings.
However, manually defining terms every time is cumbersome and impractical for everyday technical documents.
Support by SmartDox
SimpleModeling adopts SmartDox as a metalanguage that supports literate models.
SmartDox natively supports features such as automatic term linking, annotations, and glossary list generation, enabling seamless integration with the BoK even in daily writing tasks without additional burden.
Glossary in Literate Modeling
In software development, a glossary is not merely supplemental information—it is a core modeling element.
In the modeling architecture of SimpleModeling, the glossary is positioned as part of the conceptual model, serving as a central element that bridges domain models and non-engineering stakeholders.
In literate modeling as well, the glossary functionality provided by SmartDox is leveraged to integrate models with narratives.
References
Glossary
- Glossary
-
A Glossary is a knowledge resource that manages the names, meanings, boundaries, synonyms, and identifiers of terms used in a subject domain. It provides a common foundation for participants to use the same terms with the same meanings.
- BoK (Body of Knowledge)
-
At SimpleModeling, the core knowledge system for contextual sharing is called the BoK (Body of Knowledge). The goal of building a BoK is to enable knowledge sharing, education, AI support, automation, and decision-making assistance.
- SimpleModeling
-
SimpleModeling is a modeling-centered software development methodology and technology system for constructing a Domain Model from Knowledge, formalizing it in CML, realizing it as executable software through Cozy and AI, and running it on Textus.
- CBD (Component-Based Development)
-
Component-Based Development (CBD) is a software development approach in which systems are constructed and reused through components that define clear responsibilities, contracts, and interfaces. Components are designed to be independent and replaceable, enabling loosely coupled architectures that improve maintainability and reusability. In the logical model, a component serves as an abstract structural unit defining functionality and contracts; in the physical model, it corresponds to implementation and deployment units.
- Literate Model
-
Undefined
- Domain Model
-
Undefined
- Narrative
-
Undefined
- Model
-
A Model is an abstraction that represents a subject according to a particular Purpose and Concern so that it can be understood, reasoned about, evaluated, or constructed. It is not the subject itself; it preserves the elements, relationships, and meanings required for its purpose.
- Literate Modeling
-
Undefined