StorGUI - shmolyneaux/SquareJam GitHub Wiki

StorGUI is a graphic object browser written using SnakeCharmer that works in web browsers.

StorGUI Graphic Object Browser

The most basic way to interact with the database is to double click on the large icons contained in the largest section of the screen at the right. Clicking will direct you to that directory, and present you with the attributes contained within, if there is any. When you are not in the root of the database the first icon will direct you to the parent directory: it will have the name ...

Along the top of the web page there are three menus File, Edit, and Help. Each menu has a Cancel option which will close the menu.

File

Within the File menu there are three options; Make, Root Directory, and Test Page.

Make

  • Creates a new bar between the menu bar and the file area. This menu allows you to choose the type of object or data to create and the name to give it. Click cancel to remove the bar.

Root Directory

  • Clicking this will bring you to the root object in the database

Test Page

  • Allows you to test a web page within StorGUI. This allows for faster development because you do not need to open a new tab and figure out the URL to use. The disadvantage is that you cannot send form data for testing in this way.

Edit

There are 5 options in the Edit menu; Edit, Make, Copy, Paste, and Delete. All of these options except for make require an attribute to be selected.

Edit

  • Modify the attribute using the editor within StorGUI. Does not work on Dicts, Lists, or Objects, but does work on Methods and simple data types.

Make

  • Same as make for the File menu. Creates a new bar between the menu bar and the file area. This menu allows you to choose the type of object or data to create and the name to give it. Click cancel to remove the bar.

Copy

  • Stores the location of the selected attribute for later pasting. Pasting behaviour for attributes containing links is undefined.

Paste

  • Pastes the copied attribute in the current directory, overwriting the attribute if one with that name already exists.

Delete

  • Removes the attribute for the current object

Help

The three options, Login, About, and Help Page are not implemented yet.

⚠️ **GitHub.com Fallback** ⚠️