Difference between revisions of "Open these docs from Analytica"

Revision as of 03:09, 13 January 2023

As you use Analytica on the Desktop, it's very handy to link to these Analytic docs online to find and learn about a particular feature or function. Here are four quick ways to do that.

Access from the Analytica Help menu

Inside Analytica, open the Help menu, and select User Guide, Optimizer, Tutorial, wiki Home page, or Functions by category. It opens the selected wiki page in your default web browser.

Use the Find dialog to search docs online

To open the Find dialog, click in the toolbar, or press control+F.
Type into the search box the name of a function, feature, concept, or whatever you are looking for.
Click the on the Wiki button

It shows the wiki page with matching title if there is one, or a list of search results.

Right-click on a Function name

In the Definition of a variable:

Double-click the identifier of a system function, say, NPV, to select it.
Right click to open the context menu
Select Wiki help on NPV to open its wiki page with a full description and examples:

Open Object view for a function from Definition menu

From the Definition menu, go down the menu hierarchy and select a function or system variable:

When you select a function, it opens an Object window with a description -- like this one for Factorial:

For more, click the blue link Wiki help on Factorial(...) to open its doc page online.

History

Prior to Analytica 5.0, the first three options in the Help menu opened PDF documents instead of online pages.

@@ Line 1: / Line 1: @@
-[[Category: Analytica wiki]]
+[[Category: Analytica Docs]]
-When you are running Analytica, you might want to learn about a feature or find a function you need.  Here are ways to link from inside Analytica directly to a wiki page in your default web browser.
+As you use Analytica on the Desktop, it's very handy to link to these Analytic docs online to find and learn about a particular feature or function.  Here are four quick ways to do that.
-=== Open wiki from the Analytica Help menu ===
+== Access from the Analytica Help menu ==
-A simple way is to select the Analytica '''Help''' meny, and select the '''User Guide''', '''Optimizer''', '''Tutorial''', or '''Analytica wiki''':
+Inside Analytica, open the [[Help]] menu, and select  [[Analytica User Guide| User Guide]], [[Optimizer |Optimizer]], [[Analytica Tutorial| Tutorial]],  [[Analytica Wiki| wiki Home page]], or [[Functions by category]]. It opens the selected wiki page in your default web browser.
 :: [[File:Analytica wiki from Help menu.png|center]]
-:: Each of these opens the relevant wiki page,  [[Analytica User Guide]], [[Optimizer |Optimizer]], [[Analytica Tutorial]], or the [[Analytica Wiki]] home page. (In Analytica releases prior to  [[Analytica 5.0]] the first three options actually open the PDF document for the '''User Guide''', '''Optimizer''', and '''Tutorial''', respectively. These wiki versions have several advantages over the PDF documents:
-::* They contain numerous clickable cross-links;
-::* You can search all of them at once using the search box at the top right of this page or from the [[Find dialog]] (ctrl-F) inside Analytica;
-::* They are continuously updated; and
-::* You can comment on them or improve them yourself in the wiki.
-=== Open the Find dialog and select Wiki ===
+== Use the Find dialog to search  docs online ==
-# Press control+F (or select Find from the Object menu) to open the Find dialog.
-# Type in search text, which could be a concept, function, or feature.
-# Click the '''wiki''' button
-It will open the wiki in a browser tab and search it for the text you entered.
-=== Right-click on Definition for Wiki help for a system function ===
+:[[File:Find dialog with Open this wiki.png|400px]]
-To see wiki help for any function in a Definition:
+# To open the [[Find dialog]], click [[File:Find magnifying glass icon.jpg|20px]] in the [[toolbar]], or press ''control+F''.
-# Double-click the identifier of a function in the definition of a varaible, say, '''NPV''', to select it.
+# Type into the search box the name of a  function, feature, concept, or whatever you are looking for.
+# Click the '''on the Wiki''' button
+It shows  the wiki page with matching title if there is one, or a list of search results.
+== Right-click on a Function name ==
+In the Definition of a variable:
+# Double-click the identifier of a system function, say, '''NPV''', to select it.
 # '''Right click''' to open the context menu
 # Select '''Wiki help on NPV''' to open its wiki page with a full description and examples:
 :: [[File:Right click on function identifier.png|center|frameless|Select function name, open right-click menu, and select '''Wiki help''']]
-=== Open Object view for a function from Definition menu ===
+== Open Object view for a function from Definition menu ==
-From the '''Definition''' menu (if your cursor is not inside a Definition), select any function or system variable to open its Object window, and see its Description. If you want more details, click on the blue wiki help link at the end of the Description, for example:
+From the '''Definition''' menu, go down the menu hierarchy and select a function or system variable:
 [[File:Definition menu and submenu.jpg|400px]]
-It opens an Object window looking like this:
+When you select a function, it opens an Object window with a description -- like this one for [[Factorial]]:
 [[File:Object view for Factorial function.jpg|400px]]
-Click the blue link <u style="color: blue">Wiki help on Factorial(...)  </u>to open its wiki page.
+For more, click the blue link <u style="color: blue">Wiki help on Factorial(...)  </u>to open its doc page online.
+== See also ==
+* [[What are these Analytica docs?]]
+* [[Comments and suggestions for Analytica docs]]
-=== See also ===
+== History ==
-* [[What's new in this Analytica wiki?]]
+* Prior to [[Analytica 5.0]],  the first three options in the [[Help]] menu opened PDF documents instead of online pages.
-* [[Comments and suggestions for Analytica wiki]]