Extensions:Embed Service - Revision history

Draginraptor: Added instructions

2020-06-27T15:55:40Z

Added instructions

Draginraptor at 15:25, 27 June 2020

2020-06-27T15:25:52Z

Draginraptor: Blanked the page

2020-06-27T15:25:19Z

Blanked the page

Draginraptor: Draginraptor moved page Extension:Stacked Inventories to Extensions:Embed Service

2020-06-27T15:25:01Z

Draginraptor moved page Extension:Stacked Inventories to Extensions:Embed Service

Draginraptor at 15:21, 27 June 2020

2020-06-27T15:21:15Z

Draginraptor: /* Troubleshooting */

2020-06-27T15:20:16Z

Troubleshooting

Draginraptor at 15:19, 27 June 2020

2020-06-27T15:19:08Z

Draginraptor: Added most of the instructions

2020-06-27T15:18:44Z

Added most of the instructions

Draginraptor: Created blank page

2020-06-27T15:04:15Z

Created blank page

New page

@@ Line 1: / Line 1: @@
-{{Extensioninfobox|title=the extension's name|desc=A short description|auth=Author(s)|status=status (such as WIP, testing, stable)|github={{Github|user=username|branch=branch}}|migration=yes/no|package=yes/no}}
+{{Extensioninfobox|title=Embed Service|desc=Uses packages to enable data retrieval using URLs|auth=Draginraptor|status=Stable|github={{Github|user=Draginraptor|branch=embed_service}}|migration=no|package=yes}}
-<!-- Put a short summary of your extension here! -->
+This adds the EmbedController and EmbedService, which makes use of the [https://github.com/oscarotero/Embed oscarotero/Embed] library. Requires some familiarity with programming as the additions made had DeviantArt oEmbed in mind and will likely need customisation to suit your needs.
 == Installation ==
-<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
+You will need to install the [https://github.com/oscarotero/Embed oscarotero/Embed] library and have at least one of these [https://github.com/middlewares/awesome-psr15-middlewares#psr-7-implementations PSR-7 libraries]. The composer.json has already been updated to include these libraries, so if you're not worried about customisation, just run <code>composer update</code> after pulling the branch.
 == Configuration ==
-<!-- Is any configuration necessary? Describe it here! -->
+The extension is pretty bare bones so you may want to edit some of the code yourself before using it.
 == Usage ==
-<!-- Is there anything users should know about using your extension? -->
+This does not affect the site at all and is intended as a quickstart for using the [https://github.com/oscarotero/Embed oscarotero/Embed] library, where a Service and Controller has been set up, along with a relevant route.
 == Troubleshooting ==
-<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
+You can always find Draginraptor via the Lorekeeper Discord server for help. Feel free to report bugs as well.
 == See Also ==
-<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->
+* [https://github.com/oscarotero/Embed oscarotero/Embed]

← Older revision	Revision as of 15:25, 27 June 2020
Line 1:	Line 1:
	+	{{Extensioninfobox\|title=the extension's name\|desc=A short description\|auth=Author(s)\|status=status (such as WIP, testing, stable)\|github={{Github\|user=username\|branch=branch}}\|migration=yes/no\|package=yes/no}}
	+	<!-- Put a short summary of your extension here! -->
	+	== Installation ==
	+	<!-- Describe installation. Include any requirements (such as packages), necessary commands, etc. -->
	+	== Configuration ==
	+	<!-- Is any configuration necessary? Describe it here! -->
	+	== Usage ==
	+	<!-- Is there anything users should know about using your extension? -->
	+	== Troubleshooting ==
	+	<!-- Are there known issues or errors that require user action? Who should they contact, and where, for support? -->
	+	== See Also ==
	+	<!-- Any relevant other pages. You may consider linking to related extensions, for instance. -->

← Older revision		Revision as of 15:25, 27 June 2020
Line 1:		Line 1:
−	~~{{DISPLAYTITLE:Extensions:Stacked Inventories}}~~
−	<includeonly>{{Extensioninfobox\|title=Stacked Inventories\|desc=Changes items on site to display in stacks instead of one by one\|auth=Draginraptor\|status=Stable\|github={{Github\|user=Draginraptor\|branch=inventory_stacks}}\|migration=yes\|package=no}}</includeonly>
−	~~Special thanks to [https://github.com/itinerare itinerare] for isolating and testing the changes.~~

−	This changes the default inventory in Lorekeeper from displaying each user_item row as a stack of 1, and instead condenses duplicate entries into stacks. This has affected Inventory, Trades, and Design Updates the most, though there could still be remnants of code that still aren't using the new system.
−	Inventory pages will open a modal that displays a table of all the item varieties owned by the user, where the user can select and act on the items. Inventory select widgets use tables that display all items and their variations in the user's inventory.
−	~~==Installation==~~
−	~~Once the changes are pulled, the database needs to be updated as well - this can be done with:~~
−	~~<code>$ php artisan migrate</code>~~
−	The migrations will add 2 new columns to user_items: trade_count and update_count, for tracking items held in trades and updates respectively. It will also change the default value of count in user_items to 0.
−	~~==Configuration==~~
−	~~There is no need for configuration.~~
−	~~==Usage==~~
−	~~Note that existing data in the database will need to be edited such that duplicate entries (where the item_id, user_id, and data are the same) need to be combined separately.~~
−	~~You could just update each row's count column to reflect the total count at that point in time, leaving the duplicate entries alone. I'm unsure if it will break anything, but I don't think so.~~
−	You can also delete the duplicate rows once the count column is updated. However, this will probably require deleting the item logs associated with the affected stacks, unless you create your own workaround.
−
−	I have included some SQL that you can reference in creating a query, but it is unlikely to work out of the box. Alternatively, you can also edit the database manually. Either way, ALWAYS backup your database before making changes.
−
−	~~The migrations do not remove holding_type and holding_id, which are not used in this version of the inventory; these may be left in or removed on your own.~~
−	~~==Troubleshooting==~~
−	~~You can always find Draginraptor via the Lorekeeper Discord server for help. Feel free to report bugs as well.~~
−
−	~~Other users on the Discord server may also be able to help you!~~
−	~~==See Also==~~
−	-
−	~~<noinclude></noinclude>~~
−	~~{{DEFAULTSORT:Extensions:Stacked_Inventories}}~~

@@ Line 1: / Line 1: @@
 <includeonly>{{Extensioninfobox|title=Stacked Inventories|desc=Changes items on site to display in stacks instead of one by one|auth=Draginraptor|status=Stable|github={{Github|user=Draginraptor|branch=inventory_stacks}}|migration=yes|package=no}}</includeonly>
 Special thanks to [https://github.com/itinerare itinerare] for isolating and testing the changes.
@@ Line 25: / Line 26: @@
+-
 <noinclude></noinclude>

@@ Line 4: / Line 4: @@
 This changes the default inventory in Lorekeeper from displaying each user_item row as a stack of 1, and instead condenses duplicate entries into stacks. This has affected Inventory, Trades, and Design Updates the most, though there could still be remnants of code that still aren't using the new system.
 Inventory pages will open a modal that displays a table of all the item varieties owned by the user, where the user can select and act on the items. Inventory select widgets use tables that display all items and their variations in the user's inventory.
-== Installation ==
+==Installation==
 Once the changes are pulled, the database needs to be updated as well - this can be done with:
 <code>$ php artisan migrate</code>
 The migrations will add 2 new columns to user_items: trade_count and update_count, for tracking items held in trades and updates respectively. It will also change the default value of count in user_items to 0.
-== Configuration ==
+==Configuration==
 There is no need for configuration.
-== Usage ==
+==Usage==
 Note that existing data in the database will need to be edited such that duplicate entries (where the item_id, user_id, and data are the same) need to be combined separately.
 You could just update each row's count column to reflect the total count at that point in time, leaving the duplicate entries alone. I'm unsure if it will break anything, but I don't think so.
@@ Line 18: / Line 18: @@
 The migrations do not remove holding_type and holding_id, which are not used in this version of the inventory; these may be left in or removed on your own.
-== Troubleshooting ==
+==Troubleshooting==
-You can always find Draginraptor via the Lorekeeper Discord Server for help. Feel free to report bugs as well.
+You can always find Draginraptor via the Lorekeeper Discord server for help. Feel free to report bugs as well.
 == See Also ==
+-
-<noinclude>{{Documentation}}</noinclude>
+<noinclude></noinclude>

← Older revision	Revision as of 15:25, 27 June 2020
(No difference)

← Older revision	Revision as of 15:18, 27 June 2020
Line 1:	Line 1:
	+	<includeonly>{{Extensioninfobox\|title=Stacked Inventories\|desc=Changes items on site to display in stacks instead of one by one\|auth=Draginraptor\|status=Stable\|github={{Github\|user=Draginraptor\|branch=inventory_stacks}}\|migration=yes\|package=no}}</includeonly>
	+	Special thanks to [https://github.com/itinerare itinerare] for isolating and testing the changes.

	+	This changes the default inventory in Lorekeeper from displaying each user_item row as a stack of 1, and instead condenses duplicate entries into stacks. This has affected Inventory, Trades, and Design Updates the most, though there could still be remnants of code that still aren't using the new system.
	+	Inventory pages will open a modal that displays a table of all the item varieties owned by the user, where the user can select and act on the items. Inventory select widgets use tables that display all items and their variations in the user's inventory.
	+	== Installation ==
	+	Once the changes are pulled, the database needs to be updated as well - this can be done with:
	+	<code>$ php artisan migrate</code>
	+	The migrations will add 2 new columns to user_items: trade_count and update_count, for tracking items held in trades and updates respectively. It will also change the default value of count in user_items to 0.
	+	== Configuration ==
	+	There is no need for configuration.
	+	== Usage ==
	+	Note that existing data in the database will need to be edited such that duplicate entries (where the item_id, user_id, and data are the same) need to be combined separately.
	+
	+	You could just update each row's count column to reflect the total count at that point in time, leaving the duplicate entries alone. I'm unsure if it will break anything, but I don't think so.
	+
	+	You can also delete the duplicate rows once the count column is updated. However, this will probably require deleting the item logs associated with the affected stacks, unless you create your own workaround.
	+
	+	I have included some SQL that you can reference in creating a query, but it is unlikely to work out of the box. Alternatively, you can also edit the database manually. Either way, ALWAYS backup your database before making changes.
	+
	+	The migrations do not remove holding_type and holding_id, which are not used in this version of the inventory; these may be left in or removed on your own.
	+	== Troubleshooting ==
	+	You can always find Draginraptor via the Lorekeeper Discord Server for help. Feel free to report bugs as well.
	+	== See Also ==
	+	-
	+	<noinclude>{{Documentation}}</noinclude>