Skip to content

Commit

Permalink
Add a glossary to the documentation (#2212)
Browse files Browse the repository at this point in the history
  • Loading branch information
bartfeenstra authored Nov 14, 2024
1 parent 15efdc7 commit 5c0fb76
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 11 deletions.
29 changes: 29 additions & 0 deletions documentation/glossary.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Glossary
========

.. glossary::

plugin
A drop-in piece of functionality.

A plugin is a concrete class that extends :py:class:`betty.plugin.Plugin`.

Read more about :doc:`plugins </development/plugin>`.

plugin instance
An object that is an instance of a :term:`plugin` (class).

Read more about :doc:`plugins </development/plugin>`.

plugin type
A plugin type is a potentially abstract class that is or extends :py:class:`betty.plugin.Plugin`.

Read more about :doc:`plugins </development/plugin>`.

static site
A website that consists solely of prebuilt files that are served to visitors directly as they are. Read more about
`static web pages on Wikipedia <https://en.wikipedia.org/wiki/Static_web_page>`_

static site generator
A software application that builds :term:`static sites <static site>`. Read more about
`static site generators on Wikipedia <https://en.wikipedia.org/wiki/Static_site_generator>`_
6 changes: 3 additions & 3 deletions documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,16 @@ Betty Documentation
usage
development
API Documentation <modindex>
glossary
About <about>

Betty visualizes and publishes your family history by building interactive, encyclopedia-like genealogy websites out of your
`Gramps <https://gramps-project.org/>`_ and `GEDCOM <https://en.wikipedia.org/wiki/GEDCOM>`_ family trees.

Features
--------
Betty generates generates a `static site <https://en.wikipedia.org/wiki/Static_web_page>`_ from your genealogy records.
This means that once your site has been generated, you will not need any special software to publish it. It's **fast and
secure**.
Betty generates generates a :term:`static site` from your genealogy records. This means that once your site has been
generated, you will not need any special software to publish it. It's **fast and secure**.

* Builds pages for people, places, events, and media
* Renders interactive maps and family trees
Expand Down
10 changes: 2 additions & 8 deletions documentation/usage/ancestry.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,8 @@ Ancestry
ancestry/*

An ancestry is Betty's main data model. It organizes all the information in your family history
in a way that can easily be used across all parts of Betty. The main components are:

Entities
An entity is an object that describes a thing, such as a place or a person.
Fields
Individual pieces of information belonging to an entity, such as a place or person name.
Associations
A reference between entities, stored in a field on each entity.
in a way that can easily be used across all parts of Betty. The main components are entities, fields on entities, and
associations between entities.

A model with lots of data is a graph, a network, like a web of information that can be traversed,
analyzed, expanded, and ultimately generated into a site.
Expand Down

0 comments on commit 5c0fb76

Please sign in to comment.