Skip to content

Latest commit

 

History

History
56 lines (36 loc) · 3.36 KB

exploringGopage.md

File metadata and controls

56 lines (36 loc) · 3.36 KB

Exploring GoPage

While GoPage is obviously split up into its separate pages there are two Universal elements to every page.

Header

The Header contains all pages within GoPage, as well as when on the homepage any Header Plugins installed and setup.

The Header:

  • GoPage Banner: a Banner indicating the service currently being used, that will bring you to the Home Page.
  • Plugin Repo: A link to the Plugin Repo allowing installing, uninstalling, and updating plugins.
  • Background Image: Allowing to upload custom background images, set the current background image, or unset the image to leave it blank.
  • Link Health: A Page that will show if any Link Items you have the same Host Name or are the exact same link.
  • Settings: A page to modify all settings available within GoPage.
  • Left Header Plugin: If not set, a blank on the header, otherwise will display whatever is set as this Header Plugin.
  • Right Header Plugin: If not set, a blank on the header, otherwise will display whatever is set as this Header Plugin.
  • Clock, a simple clock updating every section that will show the current date and time in your current locale.

Footer

At the bottom of the page is a simple Footer containing links to this Repo or a link to help contribute to this repo.

HomePage

The Homepage is the obvious landing or entry point into GoPage, Having a simple button to create a new Link Item, a Category Selector and your current Link Items.

  • The Category Selector will get all of the declared Categories in your different Link Items and show them as tab-able Items, meaning you can click each one to show only Link Items belonging to that category for easy searching.

  • On the right side of the Category Selector will be a button to add a New Link Item, bringing up a modal with options.

  • On the left side of the Category Selector is a search bar that allows searching all saved Link Items.

  • Each Link Item will get its own small box, showing the Friendly Name, you've attributed and the data from any Plugins Attached. With an edit and delete button available after hovering over the Link Item then additionally hovering over the three vertical dots on the right side of the Link Item. Clicking either brings up a modal with additional options.

Settings Page

The Settings Page is a simple way to view data about your installation, under the Summary Section as well as containing a Tools Section.

  • Summary: Contains simple data about your current installation.

  • Tools: Contains a list of different tools built into GoPage, most notably the Plugin Repo.

Plugin Repo

The Plugin Repo is a single place to view all available GoPage Plugins you have, as well as any installed ones. Giving you the ability to Delete or Install them.

  • Plugin Item: Each Plugin Item is broken up as follows from left to right, top to bottom.
    • Icon: An Icon if specified to be shown for the Plugin.
    • Title: The Title of the Plugin as specified by the creator.
    • Link: Clicking the Title will link to the Information Link Specified for the Plugin.
    • Version: The current Version of the Plugin
    • Summary: A short summary of the Plugin, which if needing more of a breakdown you can always click the Title.
    • Author: A listing of the author's name.
    • License: The License of the Plugin Source Code.
    • Action Button: The Button to either Install or Uninstall the Plugin depending on whether or not you currently have it.