Documentation Grammar Errors

[QuickWrite]

As I read through the documentation of this GUI framework for plugins I found some grammatical errors and I think that it would be better if I would list them here in this issue.

I don't want to hurt anyone with this issue.

If you don't like to read a lot of text, you can just skip everything and go to Simpler Form where everything is also in table form.

Text

Setup

• In the sentence In order to include the framework in your project, you need to add the following to your pom.xml, in the plugins section. there is unfortunately a single comma to much: In order to include the framework in your project, you need to add the following to your pom.xml in the plugins section.
• The second sentence ( Replace [YOUR PACKAGE]with your plugin's package, for example me.myplugin.plugin.) should be separated and there needs to be a comma after the example word: Replace [YOUR PACKAGE]with your plugin's package. For example, me.myplugin.plugin.

Paginated GUI

• In "Paginated GUI" I would replace Simple GUI that allows you to have multiple pages and navigate between them with A simple GUI that allows you to have multiple pages and navigate between them.
• To have a better flow of information I would use instead of The page size, is how big the page should be, in the example above it's 45 slots dedicated for the page, if nothing is set the lib will calculate the page size when opening. a version that is split into multiple sentences: The page size is how big the page should be. In the example above, there are 45 slots dedicated to the page. If nothing is set, the lib will calculate the page size when opening.
• In the first sentence of the Creating the navigation section only a comma is missing and so I would change To create the navigation items we can simply do: into To create the navigation items, we can simply do:.
• I would just use It is recommended instead of Recommended as a start of a sentence.
• In the first sentence of the Populating the page section only a comma is missing and so I would change To add items to the page once again we use the PaginatedGui#addItem which takes a GuiItem. into To add items to the page once again, we use the PaginatedGui#addItem, which takes a GuiItem.
• And as a more stylistic approach I would just use instead of Items added with PaginatedGui#setItem will not be counted towards the page but as static GUI items. this: Items added with PaginatedGui#setItem will be treated as static GUI items rather than page items.

Scrolling GUI

• In "Scrolling GUI" I would replace Simple GUI that allows you to scroll on a Paginated GUI instead of going page by page. with A simple GUI that allows you to scroll on a Paginated GUI instead of going page by page.
• The first sentence is somehow missing: To create a Scrolling G and I would just use To create a Scrolling GUI, all you need to do is:
• In the codeblock

  ScrollingGui gui = Gui.scrolling()
          .title(Component.text("GUI Title!"))
          .rows(6)
          .pageSize(45)
          .scrollType(ScrollType.HORIZONTAL) // Not needed, defauilts to VERTICAL.
          .create();

  the word defaults has an i that is not needed:

  ScrollingGui gui = Gui.scrolling()
          .title(Component.text("GUI Title!"))
          .rows(6)
          .pageSize(45)
          .scrollType(ScrollType.HORIZONTAL) // Not needed, defaults to VERTICAL.
          .create();

• Instead of Just like the normal GUI the first parameter is the rows the GUI should have. I would use Just like the normal GUI, the first parameter is the number of rows the GUI should have
• And the sentence Like the Paginated GUI the second parameter is to specify the page size, as in how big the page should be, in the example above it's 45 slots dedicated for the page. I would split and reword the second part, as I don't think you meant It is 45 slots, into Like in the Paginated GUI, the second parameter is to specify the page size, as in how big the page should be. In the example above, there are 45 slots dedicated to the page.

Storage GUI

• In "Storage GUI" I would replace GUI that does not clear it's items on close/open, any external non GuiItem added to it will stay. (it does not persist on server restart) with Any GUI that does not clear its items on open or close will have any external non-GuideItem added to it stay (it does not persist when the server is restarted).
• I would change To create a persistent GUI all you need to do is: into To create a persistent GUI, all you need to do is:.
• Instead of Just like the normal GUI the first parameter is the rows the GUI should have. I would use Just like the normal GUI, the first parameter is the number of rows the GUI should have
• Instead of Differently to the normal GUI, the addItem method takes an ItemStack instead. I would use the words In contrast as it makes the sentence more lively and shows the difference: In contrast to the normal GUI, the addItem method takes an ItemStack instead.
• The sentence Any GuiItem added will have actions applied to it, the persistent items are simple ItemStacks that have nothing associated to it. should be separated and to it is singular and it should be plural Any GuiItem added will have actions applied to it. The persistent items are simple ItemStacks that have nothing associated with them.

GUI features

• In "GUI Features" I would replace After the basics of a GUI there is a lot more useful features you can use. with After learning the basics of a GUI, there are a lot more useful features you can use.
• To show the difference to the reader I would change The GUI filler allows you to fill in the GUI in many ways, for example, completely filling or filling the bottom or top of the GUI. to The GUI filler allows you to fill in the GUI in many ways, for example, completely filling or just filling the bottom or top of the GUI.
• The sentence Setting you fill item will fill the slots in your GUI that doesn't contain a GUI item. should be Setting the item will fill the slots in your GUI that don't contain a GUI item.
• In the sentence Just like any other item these items can also have a click action, but they'll be the same for all the slots it is filled. there is just a comma and the it is filled: Just like any other item, these items can also have a click action, but they'll be the same for all the slots they fill.
• After the for example there should be a comma and so For example if you call event.setCancelled(true) should be changed into For example, if you call event.setCancelled(true) .
• The ever in This will display the action you set when ever the GUI is closed. is not needed in this context: This will display the action you set when the GUI is closed.
• The ever in This will display the action you set when ever the GUI is open . is also not needed in this context and there is a space too much: This will display the action you set when the GUI is open.
• The sentence If you want to add a click action to a specif slot without needing to have to specify the item in the slot, you can simple use the setSlotAction. should be rewritten into If you want to add a click action to a specific slot without needing to specify the item in the slot, you can simply use setSlotAction.
• I would change The update method will update the entire GUI except the title, due to how inventories work. into Due to how inventories work, the update method will update the entire GUI except the title.
• After the for example in This is the preferable way of making updates in your GUI, for example an item that keeps refreshing, etc. there should be a comma: This is the preferable way of making updates in your GUI, for example, an item that keeps refreshing, etc.

Simpler form

As I know that this format is a little bit harder to read, I am here adding a simpler way of accessing this information in the form of a table:

Setup

Original String	New String
In order to include the framework in your project, you need to add the following to your pom.xml, in the plugins section.	In order to include the framework in your project, you need to add the following to your pom.xml in the plugins section.
Replace [YOUR PACKAGE]with your plugin's package, for example me.myplugin.plugin.	Replace [YOUR PACKAGE]with your plugin's package. For example, me.myplugin.plugin.

Paginated GUI

Original String	New String
Simple GUI that allows you to have multiple pages and navigate between them.	A simple GUI that allows you to have multiple pages and navigate between them.
The page size, is how big the page should be, in the example above it's 45 slots dedicated for the page, if nothing is set the lib will calculate the page size when opening.	The page size is how big the page should be. In the example above, there are 45 slots dedicated to the page. If nothing is set, the lib will calculate the page size when opening.
To create the navigation items we can simply do:	To create the navigation items, we can simply do:
Recommended	It is recommended
To add items to the page once again we use the PaginatedGui#addItem which takes a GuiItem.	To add items to the page once again, we use the PaginatedGui#addItem, which takes a GuiItem.
Items added with PaginatedGui#setItem will not be counted towards the page but as static GUI items.	Items added with PaginatedGui#setItem will be treated as static GUI items rather than page items.

Scrolling GUI

Original String	New String
Simple GUI that allows you to scroll on a Paginated GUI instead of going page by page.	A simple GUI that allows you to scroll on a Paginated GUI instead of going page by page.
To create a Scrolling G	To create a Scrolling GUI, all you need to do is:
ScrollingGui gui = Gui.scrolling() .title(Component.text("GUI Title!")) .rows(6) .pageSize(45) .scrollType(ScrollType.HORIZONTAL) // Not needed, defauilts to VERTICAL. .create();	ScrollingGui gui = Gui.scrolling() .title(Component.text("GUI Title!")) .rows(6) .pageSize(45) .scrollType(ScrollType.HORIZONTAL) // Not needed, defaults to VERTICAL. .create();
Just like the normal GUI the first parameter is the rows the GUI should have.	Just like the normal GUI, the first parameter is the number of rows the GUI should have
Like the Paginated GUI the second parameter is to specify the page size, as in how big the page should be, in the example above it's 45 slots dedicated for the page.	Like in the Paginated GUI, the second parameter is to specify the page size, as in how big the page should be. In the example above, there are 45 slots dedicated to the page.

Storage GUI

Original String	New String
GUI that does not clear it's items on close/open, any external non GuiItem added to it will stay. (it does not persist on server restart)	Any GUI that does not clear its items on open or close will have any external non-GuideItem added to it stay (it does not persist when the server is restarted)
To create a persistent GUI all you need to do is:	To create a persistent GUI, all you need to do is:
Differently to the normal GUI, the addItem method takes an ItemStack instead.	In contrast to the normal GUI, the addItem method takes an ItemStack instead
Any GuiItem added will have actions applied to it, the persistent items are simple ItemStacks that have nothing associated to it.	Any GuiItem added will have actions applied to it. The persistent items are simple ItemStacks that have nothing associated with them.

GUI Features

Original String	New String
After the basics of a GUI there is a lot more useful features you can use.	After learning the basics of a GUI, there are a lot more useful features you can use.
The GUI filler allows you to fill in the GUI in many ways, for example, completely filling or filling the bottom or top of the GUI.	The GUI filler allows you to fill in the GUI in many ways, for example, completely filling or just filling the bottom or top of the GUI.
Just like any other item these items can also have a click action, but they'll be the same for all the slots it is filled.	Just like any other item, these items can also have a click action, but they'll be the same for all the slots they fill.
For example if you call event.setCancelled(true)	For example, if you call event.setCancelled(true)
This will display the action you set when ever the GUI is closed.	This will display the action you set when the GUI is closed.
This will display the action you set when ever the GUI is open .	This will display the action you set when the GUI is open.
If you want to add a click action to a specif slot without needing to have to specify the item in the slot, you can simple use the setSlotAction.	If you want to add a click action to a specific slot without needing to specify the item in the slot, you can simply use setSlotAction.
The update method will update the entire GUI except the title, due to how inventories work.	Due to how inventories work, the update method will update the entire GUI except the title.
This is the preferable way of making updates in your GUI, for example an item that keeps refreshing, etc.	This is the preferable way of making updates in your GUI, for example, an item that keeps refreshing, etc.

[LichtHund]

Wow! This is amazing, I am working in migrating the documentation to a new platform and I'll definitely include all this when I transfer. Thank you so much, it's very detailed and I really appreciate it!