Sage
Welcome to Sage
Volume (80%) Hide Volume ☆
Topics ⬆ ⬇
Developer Guidelines
This article provides guidelines for Sage content developers to set up the tools needed to create new content at First Trust Portfolios.

Content is stored in .sage files and all those files are saved in CodeVault under $/Documentation/Sage.

Setup

Do the following set up to create, test and run content creation.

  • In CodeVault, add links for this projects into your personal user project or workspace.

    • $/Departments/Enterprise/SageWeb – This will serve up the compiled sage documentation.
    • $/Documentation/Sage – This contains the sage content served by SageWeb.

  • In CodeVault, override the working directory for the project root containing the Sage content so it gets saved to SageWeb\Bin\Volumes.

    Note

    We keep SageWeb and the Sage content in separate projects so they can be fetched independently.


  • Get Current recursively for those two projects.

  • Compile SageWeb.

  • Have a working copy of DSEdit available.

    Make sure DSEdit knows the root of your content as described in… Setting the Sage Library Path

Editing Content

An existing .sage file can be checked out and opened with DSEdit for editing.

If a new file is needed, create the file in the desired directory with a .sage extension and open it with DSEdit. Because it is a .sage file, it will open with the Sage Preview dialog.

One special type of .sage file is the volume file. It is named <name>.vol.sage. This file will become a volume as defined in Content Hierarchy

A volume file would be initialized with the volume tag as shown below. All content detail must be inside an article so that tag would also be needed. Finally, all articles must have some text content.

[volume SomeName] [article SomeName] Something...

As you add more, any errors will be shown at the top of the Sage Preview dialog.

When you are done with editing your file and there are no visible errors, you can hit ^ Ctrl+F9 to validate your sage unit checking for link errors.

Note

For this to work, DSEdit needs to know the root of your content tree so it can reference all link aliases. This is explained in Setting the Sage Library Path.


Selecting F9 will actually compile or build the .sagevol files which may consolidate numerous .sage files as well as image files. The .sagevol files will be used by SageWeb as the content to be displayed.

Running SageWeb

  • Compile and run SageWeb\Bin\SageWeb.exe
  • At the command line prompt, select B to open a browser pointing to your running server.
  • Login using your network login and password.
  • Verify your changes look right.

Deploying Sage Content

Sage volumes are deployed using Shadowfax. The Sage content is considered its own application within Shadowfax, and there is a separate SageContent.Shadowfax.mc script that will select all the .sagevol files under the Volumes directory.

Usually we don't deploy all the files, but simply the .sagevol files for volumes that we know contain changes. The Source Time column in the lower grid is especially helpful for identifying these volumes. It contains the latest modified timestamp of any source file that contributed to the volume. With that in mind, delete files from the lower grid that are not needed before proceeding with the deployment.

Setting Up to Deploy the First Time

If this is your first time deploying Sage changes, you will need to add the application. After launching Shadowfax, navigate to the Deployment view, then select the Console tab. Use the Options drop down menu on the main toolbar, and click Select Apps.

A dialogue will appear, listing available applications, some of which you have likely already checked to make available for deployments. Find Sage Content in the list, and check the box next to it. Click Ok to close the dialogue and apply changes.

When you select the Sage Content application, it will ask you to set the base folder. This should be the Bin folder of the Sage Web application, where your root Volumes folder resides.

Something like:

C:\Projects\SageWeb\Bin

Once you click Ok on the folder dialogue, you should see a list of files appear in the main grid. This should include the SageContent.Shadowfax.mc script.


Application Integration

Taos Template applications can be integrated with sage at a variety of levels. Traditionally, documentation was available from the Help menu and that is still recommended.

Additionally, F1 can be set up to bring up a Sage section associated with the view or control which has focus.

Instructions for setting this up are found in Sage Help for VCL Apps.

⏱ Last Modified: 11/17 12:39:43 pm
In this article (top)  View article's Sage markup
Setup Editing Content Running SageWeb Deploying Sage Content Application Integration
⏱ 11/17 12:39:43 pm