Difference between revisions of "Open these docs from Analytica"

m
(22 intermediate revisions by 2 users not shown)
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 WikipediaLike 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 functionHere 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 [mailto:support@lumina.com support@lumina.com] to set up an account.
+
== Access from the Analytica Help menu ==
  
=== How to access this wiki from inside Analytica ===
+
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.
  
==== Access wiki from Help menu ====
+
:: [[File:Analytica wiki from Help menu.png|center]]
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.
 
  
:: [[File:Analytica wiki from Help menu.png|center]]In Analytica 4.6 and earlier, the three top links, '''User Guide''', '''Optimizer''', and '''Tutorial''', open these documents as PDFs, In Analytica 5.0, these link to versions of these documents in the Analytica wiki. The advantages of the online wiki versions over the PDFs are that they can all be searched simultaneously, the contain numerous clickable cross-links, they are more uptodate, and you can comment on them or improve them yourself in the wiki. You can already see these online versions at [[Analytica User Guide]], [[Optimizer |Optimizer]], and [[Analytica Tutorial]].
+
== Use the Find dialog to search  docs online ==
  
==== 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 system function from inside Analytica.
+
 
# Select a function identifier, say, '''NPV''', in a Definition by double-clicking it.  
+
# To open the [[Find dialog]], click [[File:Find magnifying glass icon.jpg|20px]] in the [[toolbar]], or press ''control+F''.
# '''Right click''' to see the context menu  
+
# Type into the search box the name of a  function, feature, concept, or whatever you are looking for.
# Select '''Wiki help on NPV''' to open the wiki page with a full description and examples:
+
# 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''']]
 
:: [[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 ==
Another way to open the wiki page for a function '''F''' is to select that function from the '''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]]:
  
It opens an Object window with a  link <u style="color: blue">Wiki help on F</u>. Click the link to open its wiki page with details and examples.
+
[[File:Object view for Factorial function.jpg|400px]]
  
=== How to add comments or edit the wiki ===
+
For more, click the blue link <u style="color: blue">Wiki help on Factorial(...)  </u>to open its doc page online.
All users are invited to add comments and requests at the bottom of each page in the '''Comment''' section (including this page!)
 
  
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.
+
== See also ==
* '''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,  lists, and so on, and to insert links and screenshots, 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. This editor also offers a toolbar at the top for common formatting. For details, see [https://www.mediawiki.org/wiki/Help:Contents Help on mediawiki markup language].
+
* [[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]]
 
* [https://www.mediawiki.org/wiki/Help:VisualEditor/User_guide User Guide for Visual Editor]
 
* [https://www.mediawiki.org/wiki/Help:Contents Help on wiki format]
 

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.

Analytica wiki from Help menu.png

Use the Find dialog to search docs online

Find dialog with Open this wiki.png
  1. To open the Find dialog, click Find magnifying glass icon.jpg in the toolbar, or press control+F.
  2. Type into the search box the name of a function, feature, concept, or whatever you are looking for.
  3. 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:

  1. Double-click the identifier of a system function, say, NPV, to select it.
  2. Right click to open the context menu
  3. Select Wiki help on NPV to open its wiki page with a full description and examples:
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: Definition menu and submenu.jpg

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

Object view for Factorial function.jpg

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

See also

History

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


You are not allowed to post comments.