add terminology documentation

deepsource-autofix-76c6eb20
Dan Gowans 2022-09-21 10:21:05 -04:00
parent 1c6f3a15dd
commit 7e692b9ecb
4 changed files with 32 additions and 1 deletions

View File

@ -4,5 +4,10 @@
**Thank you for taking the time to read the documentation.**
![Lot Occupancy View](images/lotOccupancyView.png)
[**Terminology**](terminology.md)<br />
Understanding the key terms used in the Lot Occupancy System.
[**Map Images**](mapImages.md)<br />
How to create images compatible with the Lot Occupancy System.

Binary file not shown.

After

Width:  |  Height:  |  Size: 95 KiB

View File

@ -0,0 +1,26 @@
[Home](https://cityssm.github.io/lot-occupancy-system/)
[Help](https://cityssm.github.io/lot-occupancy-system/docs/)
# Terminology
_Note that is is possible to substitute the default terminology using the application's config file._
| Term | Description | Cemetery System Alias Example |
| --------- | ---------------------------------------------- | ----------------------------- |
| Map | The highest level object, a group of lots. | Cemetery |
| Lot | The smallest occupiable piece of land. | Burial Site |
| Occupancy | A reservation on a lot for a specific purpose. | Occupancy |
| Occupant | A person associated with a lot occupancy. | Occupant |
For example in the context of a cemetery system, John Doe has passed away and has been interred.
- John Doe would be considered an **occupant**.
- An **occupancy** record would be created with **no end date** and associated with his **burial site (lot)** of choice.
- The **burial site (lot)** is associated with the **cemetery (map)** where John is buried.
For example in the context of a marina, Jane Smith and her boat are renting a slip for a week.
- Jane Doe, and possibly the others on her boat, would be considered **renters (occupants)**.
- A **reservation (occupancy)** record would be created for the duration of her stay, and associated with the **slip (lot)** of choice.
- The **slip (lot)** is associated with the **marina (map)** where the slip is located.

View File

@ -8,7 +8,7 @@ const publicSCSSDestination = "public/stylesheets";
const publicSCSSFunction = () => {
return gulp
.src("public-scss/*.scss")
.pipe(sass({ outputStyle: "compressed" }).on("error", sass.logError))
.pipe(sass({ outputStyle: "compressed", includePaths: ["node_modules"] }).on("error", sass.logError))
.pipe(gulp.dest(publicSCSSDestination));
};
gulp.task("public-scss", publicSCSSFunction);