Skip to content

Framework

Templates and Documents are presented in the Formbird Framework. The framework controls global functions for various activities.

              alt text

  • Menu - click to slide the menu from the right, click again to retract
  • Shortcuts - quick links to commonly used documents. These can be created by the user and/or by the application designer.
  • Add shortcut - click the pen to enter menu edit mode. Once in edit mode, click the + button to add a new short cut, or you can edit/delete existing shortcuts by clicking the pen or delete button on the shortcut. Sub menus can be made by clicking the pen on an existing shortcut.
  • Add Image - Adds an image to the top right corner of the framework
  • Print - prints the document
  • New - creates a new document from it's corresponding template
  • Delete - deletes a document
  • Document Name - the systemHeader.summaryName of the document
  • Global Search - returns results from search terms typed into the field. Terms searched for include all data on the documents (including attachments such as pdf's). Press enter after entering search terms to see full results, or select from the first 50 results returned in the dropdown. The summaryName is displayed for the dropdown and the summaryName and summaryDescription is displayed for the full search. Note: Documents to which the logged in user does not have access are excluded from the results.
  • Command Bar - the area which the command buttons reside
  • Account Menu - includes application information, a link to the users account document and a 'sign out' command for exiting the application
  • Online Status - The application can include an 'offline mode' where documents are cached and synced when comms are next available. Green = Online, Red = Offline

  • Add New Menu Item - To add a new menu item, click the "+" button in the menu edit mode. A dialog will appear with the following fields:

    • Name - The display name of the menu item.
    • Description - A brief description of the menu item.
    • Is Application Link - A checkbox to indicate if the menu item is a link to an application. If this is unchecked, you can set the address as an external URL. For example, https://www.formbird.com would work, but some websites like https://www.google.com may not work due to frame-busting techniques. For more information on frame-busting, visit this explanation on frame-busting techniques.
    • Address - The URL or path that the menu item links to. This can be an internal path or an external URL, based on the status of the 'Is Application Link' checkbox.
    • Icon - An option to select an icon to represent the menu item. Icons can be chosen from Google's icon library, available at https://fonts.google.com/icons.
    • Target - A dropdown to select where the link will open: "Current Window" or "New Tab".