From 5fddb044b84b3b99ecc3469f306a4e98fa78da10 Mon Sep 17 00:00:00 2001 From: tariqksoliman Date: Wed, 25 Oct 2023 16:47:45 -0700 Subject: [PATCH] Add file_description tagging schemes to DB docs 2 --- docs/pages/Database/DrawTool/DrawTool.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/pages/Database/DrawTool/DrawTool.md b/docs/pages/Database/DrawTool/DrawTool.md index 2b777ff6..838a7024 100644 --- a/docs/pages/Database/DrawTool/DrawTool.md +++ b/docs/pages/Database/DrawTool/DrawTool.md @@ -22,9 +22,9 @@ 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}` + - ` ~^{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` - `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.