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]]
-These pages are in the form of wiki. It uses [https://en.wikipedia.org/wiki/MediaWiki MediaWiki], the same engine that powers wikipedia.  Like wikipedia, any user can improve and add pages for the benefit of others -- in this case the growing community of Analytica users.
+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.
-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.
+== Access from the Analytica Help menu ==
-From inside Analytica on your desktop, you can open the [[Analytica Wiki]] home page in your default web browser  by selecting '''Analytica wiki''' from the '''Help''' menu.
+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]]
+:: [[File:Analytica wiki from Help menu.png|center]]
-Analytica also offers direct links to wiki help on system functions. For example, double click on a function identifier to select it. Then right click and select Wiki help on Fn to open a wiki page describing that function:
+== Use the Find dialog to search  docs online ==
-:: [[File:Right click on function identifier.png]]
+:[[File:Find dialog with Open this wiki.png|400px]]
-Or 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.
+# 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 the Wiki''' button
+It shows  the wiki page with matching title if there is one, or a list of search results.
-All users are invited to add comments and requests at the bottom of each page in the '''Comment''' section (including this page!)
+== Right-click on a Function name ==
-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.
+In the Definition of a variable:
-* '''Edit''' opens the whole page using the WYSYWIG (What You See Is What You Get) [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide Visual Editor]. You can use the controls in a toolbar 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.
+# 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''']]
-* '''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. This editor also offers a toolbar at the top for common formatting. For details, see [https://www.mediawiki.org/wiki/Help:Content Help on mediawiki markup language].
+== Open Object view for a function from Definition menu ==
-[[How to edit Analytica wiki]]: Guidelines for editing to this wiki.
+From the '''Definition''' menu, go down the menu hierarchy and select a function or system variable:
-[[Comments and suggestions for Analytica wiki]]: Here's how we can improve this Wiki.
+[[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">Wiki 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.