Skip to content

Commit

Permalink
Add file_description tagging schemes to DB docs 3
Browse files Browse the repository at this point in the history
  • Loading branch information
tariqksoliman committed Oct 26, 2023
1 parent 5fddb04 commit 71b4849
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ source "https://rubygems.org"
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
gem "jekyll", "~> 3.9.0"
#
gem "jekyll-include-cache"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "just-the-docs", "~> 0.3.3"
# So gh-pages can use remote themes
Expand Down
3 changes: 3 additions & 0 deletions docs/Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,8 @@ GEM
jekyll-github-metadata (2.13.0)
jekyll (>= 3.4, < 5.0)
octokit (~> 4.0, != 4.4.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-mentions (1.6.0)
html-pipeline (~> 2.3)
jekyll (>= 3.7, < 5.0)
Expand Down Expand Up @@ -292,6 +294,7 @@ DEPENDENCIES
github-pages (~> 214)
jekyll (~> 3.9.0)
jekyll-feed (~> 0.12)
jekyll-include-cache
jekyll-remote-theme
just-the-docs (~> 0.3.3)
tzinfo (~> 1.2)
Expand Down
11 changes: 7 additions & 4 deletions docs/pages/Database/DrawTool/DrawTool.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,13 @@ The `user_files` table stores an entry for each file a user created via the Draw
- `file_owner_group`: In special cases, a group of users can be the owner of a file. This is currently hardcoded only for Lead users.
- `file_name`: The name of the drawing file.
- `file_description`: The description of the file. File tags also get encoded into this description field based on the following:
- ` ~^{str}`: denotes that this file is in a '{tag}' elevated(/prioritized) folder of the Draw Tool.
- ` ~@{str}`: denotes that this file is in a '{tag}' folder of the Draw Tool.
- ` ~#{str}`: denotes that this file has a tag of the name '{str}'
Ex. `This is the visible description. ~^elevFolder1 ~@normalFolder ~#tag1 ~#tag2`
- `~^{str}`: denotes that this file is in a `{tag}` elevated(/prioritized) folder of the Draw Tool.
- `~@{str}`: denotes that this file is in a `{tag}` folder of the Draw Tool.
- `~#{str}`: denotes that this file has a tag of the name `{str}`.

Ex. `This is the visible description. ~^elevFolder1 ~@normalFolder ~#tag1 ~#tag2`
_Note: Each pattern must begin with a space_

- `is_master`: Is this file one of the default Lead files.
- `intent`: States the purpose of the file. While being deprecated, Lead Maps still uses this to differentiate between ROIs, Campaigns, etc. This field is important when uses the review/publish functionality.
- `public`: Is the file visible to all users or just its owner.
Expand Down

0 comments on commit 71b4849

Please sign in to comment.