Home
Concepts
This section of the documentation covers the use of Objects, Libraries and References, Notations, Styles and Types and how each is created, edited and used in the Sym application.
Objects
An object is the basic building block of all of the symbolic content contained in a document - every term in every symbolic expression in Sym is an instance of an object. Many of the objects used in Sym have an object definition that specifies how the object looks and behaves, but it's also possible to create objects that don't have object definitions. All objects are identified by their name and object names are always defined in a specific namespace. All object definitions contain a type definition. Optionally, objects can also contain Properties, Clauses, Renderings, and a Description.
Autogenerated Objects
Functions that Generate Object Definitions
A library can include functions that generate a list of object definitions. These functions can be configured so that they are executed as part of the build process and the object definitions that are returned are collected in the Autogenerated Objects library. Examples include the list of Colors and a list of objects that represent each of the libraries currently loaded into the document.

Concepts
This section of the documentation covers the use of Objects, Libraries and References, Notations, Styles and Types and how each is created, edited and used in the Sym application.
- Objects
  An object is the basic building block of all of the symbolic content contained in a document - every term in every symbolic expression in Sym is an instance of an object. Many of the objects used in Sym have an object definition that specifies how the object looks and behaves, but it's also possible to create objects that don't have object definitions. All objects are identified by their name and object names are always defined in a specific namespace. All object definitions contain a type definition. Optionally, objects can also contain Properties, Clauses, Renderings, and a Description.
  - Object Modules
    An Object Module contains object definitions. Object definitions contain the name, type definition, renderings, code and properties that define the functionality of every object. Object Modules are created, edited and managed using the Document Explorer.
  - Creating and Editing Objects
  - Objects Used in Code
    Objects that are commonly used in clauses in function are listed below.
  - Property Objects
  - Special Objects
  - Autogenerated Objects
    - The Autogenerated Objects Library
      The Autogenerated Objects library is populated during the build process. The list of object modules and objects in the Autogenerated Objects library can be customized and extended.
    - Functions that Generate Object Definitions
      A library can include functions that generate a list of object definitions. These functions can be configured so that they are executed as part of the build process and the object definitions that are returned are collected in the Autogenerated Objects library. Examples include the list of Colors and a list of objects that represent each of the libraries currently loaded into the document.
  - Monoids
    Monoids are typically defined as a binary mapping that has an identity element and is associative. In the construction of the Sym application, we have taken an equivalent, but different approach to defining and handling monoids. It may be surprising to see something so fundamental defined in a non-standard way, so the reasoning for taking this approach is explained below.
- Library Locations and References
  Locations are used to manage groups of libraries and documents. The purpose of locations is to make documents portable from one machine to another. To do that, locations can be online as well as on your local machine. If a document references online libraries, the required libraries will be downloaded automatically when the document is opened.
- Notations and Rendering
  The purpose of notations is to make it possible to easily change the way expressions are displayed. Notations are assigned to Document Modules, Unit Test Modules and Object Modules. The notation assigned determines which renderings are selected for each expression in the module.
- Styles
  Each notation refers to a stylesheet. Stylesheets define Styles. Styles are used in two places. First, they can be used to style text. Second, they can be used to style parts of an expression in a rendering. You can create new style and new stylesheets.
- Types
  Every term in every expression in a Sym document has a type assigned to it. Every object definition has a type definition as one of its components. Since type definitions can include things like type variables, Sym uses a type inferencing process to determine the explicit types assigned to each term in every expression.

Functions that Generate Object Definitions

A library can include functions that generate a list of object definitions. These functions can be configured so that they are executed as part of the build process and the object definitions that are returned are collected in the Autogenerated Objects library. Examples include the list of Colors and a list of objects that represent each of the libraries currently loaded into the document.

Functions that generate object definitions

These functions are typed as ObjectDefinition and either return a single object definition or a List of object definitions.

The ObjectGenerator property

An object definition with this property that is a Sym function will be called during the build process and the results will be used to dynamically generate object definitions. An object definition with this property must have a type definition that has ObjectDefinition as its result type or an error will be generated during the build process. The ObjectGenerator property takes one parameter. The object of type ObjectModule provided as the parameter is the name of the module in the Autogenerated Objects library where the autogenerated object definitions will be placed.

You can find all of the functions that are designed to autogenerate object definitions by searching for the ObjectGenerator property in the Find and Replace window. Autogenerated objects can also be searched in the Object Browser like any other object.

Built in functions that generate object definitions

GetLibraryDefinitions
GetColorDefinitions
GetBuiltInFunctionDefinitions
GetTypeObjectDefinitions
GetNamespaceDefinitions