Difference between revisions of "Open these docs from Analytica"

Latest revision as of 01:02, 23 May 2025

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.

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 Docs button

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

Access from the Analytica Help menu

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

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 Docs help on NPV to open its docs 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 Docs 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: @@
-These pages are in the form of wiki. It uses mediawiki, the same engine that powers wikipedia.  Like wikipedia, any user can improve and add content for the benefit of the whole Analytica community.
+[[Category: Analytica Docs]]
-If you have a paid Analytica license with current support, you can set up an account with edit access from Analytica, from the '''Wiki login info...''' option in the '''Help''' menu.  Or you can email support@Lumina.com to set up an account.
+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.
-From inside Analytica, you can open the [[Analytica Wiki]] home page in your default web browser  by selecting '''Analytica wiki''' from the '''Help''' menu. Analytica also offers direct links to wiki help on system functions. Select a function ''F'' from the '''Definition''' menu, and it will open an Object window with a blue link saying ''Wiki help on F''. Click the link to open a wiki page with details and examples for that function.
+== Use the Find dialog to search  docs online ==
-When you're signed in, you can select '''Edit''' or '''Edit source''' from the '''This page''' pulldown menu at the top of each wiki page.
+:[[File:Find dialog with Open this wiki.png|400px]]
-* ''Edit''' opens the whole page in a WYSYWIG (What You See Is What You Get) editor. You can use the controls at the top to format text, including bold, italic, headings, bulleted lists, inserting links and screenshots, and so on, without needing to learn the wiki markup language.
-* '''Edit source''' opens the page (or a section under a heading) showing the underlying wiki markup language. This is the same language used in wikipedia. For details, see [https://www.mediawiki.org/wiki/Help:Content Help on mediawiki markup language]
+# To open the [[Find dialog]], click [[File:Find magnifying glass icon.jpg|20px]] 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 Docs''' button
+It shows  the docs page with matching title if there is one, or a list of search results.
-[[How to edit Analytica wiki]]: Guidelines for editing and adding content.
+== Access from the Analytica Help menu ==
-[[Comments and suggestions for Analytica wiki]]: Here's how we can improve this Wiki.
+Inside Analytica, open the [[Help]] menu, and select  [[Analytica User Guide| User Guide]], [[Optimizer |Optimizer]], [[Analytica Tutorial| Tutorial]],  [[Analytica Docs| Docs Home page]], or [[Functions by category]]. It opens the selected docs page in your default web browser.
+:: [[File:Analytica wiki from Help menu.png|center]]
+== 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 '''Docs help on NPV''' to open its docs 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 ==
+From the '''Definition''' menu, go down the menu hierarchy and select a function or system variable:
+[[File:Definition menu and submenu.jpg|400px]]
+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]]
+For more, click the blue link <u style="color: blue">Docs help on Factorial(...)  </u>to open its doc page online.
+== See also ==
+* [[What are these Analytica docs?]]
+* [[Comments and suggestions for Analytica docs]]
+== History ==
+* Prior to [[Analytica 5.0]],  the first three options in the [[Help]] menu opened PDF documents instead of online pages.