Documentation

Summary

The ADISRA SmartView is a powerful software with many different possibilities and the documentations are a great ally for the user to make the most of the ADISRA SmartView.  

This page explains how to access the different documentation types for ADISRA SmartView.  Documentation is located on the ADISRA website, YouTube, and some accompany the ADISRA SmartView software installation.

Help

The Help file is a tool which contains pages with information and instruction on all ADISRA SmartView functions and configurations.

There are two (2) ways to open the help file from ADISRA SmartView Engineering Tool:

Quick Access Toolbar:

Also, it is easy to open the Help file by clicking the “?” button on the
properties Grid.  In this example, a button object is selected and when the “?”
is pressed.  It will automatically open the button object page in Help:

The help file has three (3) tabs: 

  1. Contents 
  2. Index 
  3. Search

Contents

The Contents tab holds the entire documentation organized by categories in a
tree view.  To navigate between pages, expand the category to see the pages
and other categories.  It is important to understand that the category itself is
also a page, please see two (2) examples below:

Index

The Index tab lists the pages organized in alphabetical order.  To open a
page, select it and click the “Display” button or simply double click a topic.
There is also an input field where the title of the topic can be typed to find it
more easily:

Search

The Search tab locates pages by searching words that are present inside the
page.  Use the input field to type in the word being searched and press enter
key or click the “List Topics” button.  All the pages that contain the searched
word will be listed.  Then select one topic and click the “Display” button or
simply double click the topic.  The selected page will open and every
occurrence of the searched word will be highlighted in the page:

Using the Help

We will show some examples on how to use the help.

Informations about Dynamic fill:

How to use the ellipse dynamic fill? Use the contents tab to locate the
ellipse’s page, then open it and scroll down the page to find the brushes
properties then open the Fill Color by clicking the link.  The image
below indicates red lined items in the Contents tab until it reaches the
Fill Color property.

After opening the Fill Color property, the Fill Color page will be
displayed, showing different Fill options.  Please click in the “Dynamic
Fill” option as shown below.

And then the page can be used as an example to help configure the
object:

The page may also be located by using the nodes in the contents tab, or
search:

Informations about System Function Library:

Follow the same procedure to use the System Function Library.  Find
the desired page using the nodes in the contents tab or search for the
page.  When the page opens, it will have a detailed explanation on
how to use the functions and show examples:

 
 

Web Site

As mentioned before, the ADISRA web site (www.adisra.com) has guides and
documentation:

White Papers

The White Papers are guides that contain detailed specific subject
information.  The guides are being released according to the user’s needs.

To have access to the White Papers please use the menu on the web site or
directly access the link www.adisra.com/guides:

To open White Papers, select the one desired and it will open in a new
browser tab:

Web Help

The Web Help is similar to the Help file but it is divided into main topics.
Web Help consists of a side menu with pages and topics that can be
expanded.

Videos

The ADISRA website offers a selection of helpful videos providing how to use
examples and how to configure ADISRA SmartView functions.

To access the videos, please use the menu on ADISRA’s website home page.
Select Support, Resources, then Video Library or directly access the link
www.adisra.com/video-library:

To watch the videos, simply select one and it will automatically play:

C# Script

The ADISRA web site provides a document called “C# Script Reference” that
helps to understand available C# Scripts and the various places they can be
used within the application.  It will also explain the build process performed
by ADISRA SmartView Engineering Tool and the process outputs.

To access this document, select the “Getting Started” option in the menu on
the ADISRA web site home page or directly access the link
www.adisra.com/quick-start.

Scroll down the page and locate this menu.  Select the “C# Script Option”
and click Download: [the name of the document] as shown below in the image:

Getting Started Guide

The ADISRA web site also has a document called “Advanced Getting Started
Guide.”  This document is a step-by-step guide on how to install, configure,
and use ADISRA SmartView.  It assists in creating a project and shows the
end results.

To access this document, select the “Getting Started” option in the menu on
the ADISRA web site home page or directly access the link adisra.com/quickstart:

Scroll down to the end of the page to locate the link “Advanced Getting
Started Guide”:

New Documentation

ADISRA frequently updates existing documentation and creates new
documentation.  Users can always suggest new documents and white papers
they would like to have available.  ADISRA is customer-focused and will be
delighted to provide them.