diff --git a/docs/01) Getting Started/D) SubCategories.md b/docs/01) Getting Started/D) SubCategories.md new file mode 100644 index 0000000..47c3b97 --- /dev/null +++ b/docs/01) Getting Started/D) SubCategories.md @@ -0,0 +1,150 @@ +# Subcategories + +Subcategories provide an additional level of organization inside the Warehouse. +Instead of placing every item directly inside a main category, related items can be grouped together inside subcategories. + +For example: + +```text +Building Blocks +│ +├── Stone +├── Wood +├── Concrete +└── Glass +``` + +Each subcategory can contain items just like a normal category. + +--- + +## Creating a Subcategory + +Subcategories are created from an existing item. +To create a subcategory, first open the category containing the item you want to use. + +> **NOTE:** When an item is converted into a SubCategory, the SubCategory is created +> with a copy of the item as the link. The actual item is then moved inside the SubCategory. + +Open the item's **Item Options Menu** and select the option to "Convert To New SubCategory". +Do this by Sneak + cliking the item you wish to convert into a subcategory. + +📷 Screenshot + +![Plugins Folder](../images/ConvertToNewSubCategory.jpg) + +--- + +## Internal Name + +The first step is entering the subcategory's **Internal Name**. +The Internal Name is used internally by RS-Warehouse and must be unique. +Enter the desired internal name and pick up the Green Wool. + +For example: + +```text +wood +``` + +The Internal Name is not normally displayed to players. + +> **NOTE:** Choose the Internal Name carefully. It should be unique and should describe the purpose of the subcategory. + +📷 Screenshot + +![Plugins Folder](../images/SubCatInternalName.jpg) + +--- + +## Display Name + +Next, enter the **Display Name**. +The Display Name is the name players will see when viewing the Warehouse. +Enter the display name and pick up the green wool. + +For example: + +- Wood +- Stone +- Concrete +- Glass + +📷 Screenshot + +![Plugins Folder](../images/SubCatDisplayName.jpg) + +--- + +## Adding a Description + +You can optionally add a description to the subcategory. +The description is displayed as lore when players view the subcategory. +You can add up to 5 lines of lore. Each line may contain up to 50 characters. + +Choose a book. Each book represents a line of lore. + +Click the book for the corresponding lore line you wish to add/edit. +Press "T" to open a chat and enter the test you wish to display as the lore. +Once you press "Enter", the text will be saved to the book. +Once you are finished editing the desired "lore" lines simply grab the green Wool +to save the SubCategory. + +For example: + +```text +Wood blocks and related building materials. +``` + +📷 Screenshot + +![Plugins Folder](../images/SubCatLore.jpg) + +--- + +## Finishing the Subcategory + +Once the information has been completed, confirm the creation. +The item used to create the subcategory will become a link to the new subcategory. +Clicking that item will open the subcategory and display the items stored inside it. +The original item is no longer treated as a normal item in that location. + +--- + + +## Moving Items Into a Subcategory + +Once a subcategory has been created, items can be moved into it. +This allows you to organize large categories into smaller groups. + +For example: + +```text +Building Blocks +│ +├── Stone +│ ├── Stone +│ ├── Cobblestone +│ └── Stone Bricks +│ +├── Wood +│ ├── Oak Planks +│ ├── Spruce Planks +│ └── Birch Planks +│ +└── Concrete + ├── White Concrete + ├── Red Concrete + └── Blue Concrete + +``` + +## Opening a Subcategory + +Subcategories appear as an item inside their parent category. +A SubCategory link can be created out of items within a SubCategory creating multiple levels of organization +within a category. +Click the subcategory item to open it and view the items inside. +You can then browse, deposit, withdraw, and manage the items contained within that subcategory just like other Warehouse items. + +--- \ No newline at end of file diff --git a/docs/Blank Pages/FAQ.md b/docs/50) Side Pages/FAQ.md similarity index 100% rename from docs/Blank Pages/FAQ.md rename to docs/50) Side Pages/FAQ.md diff --git a/docs/Blank Pages/Subcategories.md b/docs/Blank Pages/Subcategories.md deleted file mode 100644 index 25946d4..0000000 --- a/docs/Blank Pages/Subcategories.md +++ /dev/null @@ -1,76 +0,0 @@ -# Subcategories - -Subcategories allow large categories to be broken into smaller groups. - -Example: - -Building Blocks - -- Stone -- Wood -- Glass -- Decorative - ---- - -## Creating a Subcategory - -Open Category Management. - -Choose a category. - -Select Subcategories. - -📷 Screenshot - ---- - -## Create Subcategory - -Choose Create. - -📷 Screenshot - ---- - -## Internal Name - -Enter a unique internal name. - -📷 Screenshot - ---- - -## Display Name - -Enter the player-visible name. - -📷 Screenshot - ---- - -## Icon - -Select an icon. - -📷 Screenshot - ---- - -## Description - -(Optional) - -📷 Screenshot - ---- - -## Finished - -The subcategory is now available. - ---- - -⬅️ Previous: [Categories](C)%20Categories.md) - -➡️ Next: [Depositing Items](../02)%20Depositing%20And%20Withdrawing/Depositing-Items.md) \ No newline at end of file diff --git a/docs/Home.md b/docs/Home.md index d0d5d39..b15e5ce 100644 --- a/docs/Home.md +++ b/docs/Home.md @@ -11,22 +11,23 @@ - [UnCategorized Category](50%29%20Side%20Pages/UnCategorized%20Category.md) - [Depositing Items](02%29%20Depositing%20And%20Withdrawing/A%29%20Depositing%20Items.md) - [Withdrawing Items](02%29%20Depositing%20And%20Withdrawing/B%29%20Withdrawing%20Items.md) - +- [Commands] +- ### Organization - [Categories](01%29%20Getting%20Started/C%29%20Categories.md) -- [Subcategories] +- [Subcategories](01%29%20Getting%20Started/D%29%20SubCategories.md) - [UnCategorized](50%29%20Side%20Pages/UnCategorized%20Category.md) -- [Database Template Selection](50%29%20Side%20Pages/Database%20Selection.md) + ### Administration - [Permissions] -- [Commands] - [Configuration](50%29%20Side%20Pages/Config%20File.md) - +- [Database Template Selection](50%29%20Side%20Pages/Database%20Selection.md) +- ### Reference -- [FAQ] +- [FAQ](50%29%20Side%20Pages/FAQ.md) --- \ No newline at end of file diff --git a/docs/images/ConvertToNewSubCategory.jpg b/docs/images/ConvertToNewSubCategory.jpg new file mode 100644 index 0000000..af62722 Binary files /dev/null and b/docs/images/ConvertToNewSubCategory.jpg differ diff --git a/docs/images/SubCatDisplayName.jpg b/docs/images/SubCatDisplayName.jpg new file mode 100644 index 0000000..7eee438 Binary files /dev/null and b/docs/images/SubCatDisplayName.jpg differ diff --git a/docs/images/SubCatInternalName.jpg b/docs/images/SubCatInternalName.jpg new file mode 100644 index 0000000..8017399 Binary files /dev/null and b/docs/images/SubCatInternalName.jpg differ diff --git a/docs/images/SubCatLore.jpg b/docs/images/SubCatLore.jpg new file mode 100644 index 0000000..a5e362c Binary files /dev/null and b/docs/images/SubCatLore.jpg differ