<?xml version="1.0"?>
<feed xmlns="http://www.w3.org/2005/Atom" xml:lang="en">
	<id>https://docs.analytica.com/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Lchrisman%2Bopus</id>
	<title>Analytica Docs - User contributions [en]</title>
	<link rel="self" type="application/atom+xml" href="https://docs.analytica.com/api.php?action=feedcontributions&amp;feedformat=atom&amp;user=Lchrisman%2Bopus"/>
	<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php/Special:Contributions/Lchrisman%2Bopus"/>
	<updated>2026-11-20T22:04:46Z</updated>
	<subtitle>User contributions</subtitle>
	<generator>MediaWiki 1.43.11</generator>
	<entry>
		<id>https://docs.analytica.com/index.php?title=Document_style_guide&amp;diff=65932</id>
		<title>Document style guide</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=Document_style_guide&amp;diff=65932"/>
		<updated>2026-11-20T00:10:51Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Redirect pages: #REDIRECT must be the first line (MediaWiki ignores it after category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;[[Category: Documentation guidelines]]&lt;br /&gt;
&lt;br /&gt;
This style guide is designed to help us write language that is clear and easy to read. It applies to all Analytica and Lumina written material, including Analytica docs, including [[Analytica Tutorial]], [[User Guide]]s, emails, proposals, reports, and even error messages. &lt;br /&gt;
&lt;br /&gt;
Many of these guidelines are fairly standard for technical writers and editors. We&#039;ve borrowed and adapted liberally from standard style manuals. The main goal is to make the language easy to read by avoiding unecessary words and convoluted grammar. Some guidelines, especially for terminology, is specific to Analytica docs.  &lt;br /&gt;
&lt;br /&gt;
Feel free to edit any wiki pages to make them follow this guide more closely.&lt;br /&gt;
&lt;br /&gt;
For style guidelines for Analytica models see [[Analytica model style guide]].&lt;br /&gt;
&lt;br /&gt;
== Language  ==&lt;br /&gt;
&lt;br /&gt;
=== Use imperative, active voice, and present tense ===&lt;br /&gt;
&lt;br /&gt;
Use the &#039;&#039;&#039;imperative&#039;&#039;&#039; -- directly telling the reader what to do -- when suggesting or explaining what to do (as we do here), because it concise and direct -- for example:&lt;br /&gt;
* Select &#039;&#039;&#039;Graph setup&#039;&#039;&#039; from the &#039;&#039;&#039;Result&#039;&#039;&#039; menu&lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Not:&#039;&#039;&#039;&#039;&#039; The user should select select &#039;&#039;&#039;Graph setup&#039;&#039;&#039; from the &#039;&#039;&#039;Result&#039;&#039;&#039; menu. &lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;And Definitely not:&#039;&#039;&#039;&#039;&#039; The &#039;&#039;&#039;Graph setup&#039;&#039;&#039; should be selected from the &#039;&#039;&#039;Result&#039;&#039;&#039; menu.&lt;br /&gt;
&lt;br /&gt;
Imperative is especially useful for a series of steps for you (the &amp;quot;user&amp;quot;) to perform. Number the steps only when you must perform them in that sequence:&lt;br /&gt;
#Select &#039;&#039;&#039;Graph setup...&#039;&#039;&#039; from the &#039;&#039;&#039;Result&#039;&#039;&#039; menu&lt;br /&gt;
#Check &#039;&#039;&#039;Stacked&#039;&#039;&#039; option&lt;br /&gt;
#Click &#039;&#039;&#039;OK&#039;&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
The imperative is technically a form of &amp;quot;active voice&amp;quot;, where &amp;quot;you&amp;quot; (the reader or software user) is the implied subject. Sometimes it is helpful to make the subject -- i.e.&amp;quot;you&amp;quot; explicit -- for example:&lt;br /&gt;
* You should avoid the passive voice.  &lt;br /&gt;
* &#039;&#039;&#039;Not:&#039;&#039;&#039; The passive voice should always be avoided &lt;br /&gt;
* When you press &#039;&#039;ctrl+F&#039;&#039;, it opens the &#039;&#039;&#039;Find&#039;&#039;&#039; dialog.  &lt;br /&gt;
* &#039;&#039;&#039;Not:&#039;&#039;&#039; When the user presses &#039;&#039;ctrl+F&#039;&#039;, the &#039;&#039;&#039;Find&#039;&#039;&#039; dialog is displayed.&lt;br /&gt;
&lt;br /&gt;
Use &#039;&#039;&#039;present not future&#039;&#039;&#039; tense for what Analytica does: &lt;br /&gt;
* Press &#039;&#039;ctrl+F&#039;&#039; and it opens the &#039;&#039;&#039;Find&#039;&#039;&#039; dialog.&lt;br /&gt;
* &#039;&#039;&#039;Not&#039;&#039;&#039;: When you press &#039;&#039;ctrl+F&#039;&#039;, it &#039;&#039;will&#039;&#039; display the &#039;&#039;&#039;Find&#039;&#039;&#039; dialog.&lt;br /&gt;
* &#039;&#039;&#039;Better&#039;&#039;&#039;: Press &#039;&#039;ctrl+F&#039;&#039; to open the &#039;&#039;&#039;Find&#039;&#039;&#039; dialog.&lt;br /&gt;
&lt;br /&gt;
=== You, we, it, and Analytica ===&lt;br /&gt;
&lt;br /&gt;
As you saw above, we use &amp;quot;you&amp;quot; to refer to the reader or software user, and &amp;quot;we&amp;quot; or &amp;quot;us&amp;quot; to refer to the writer or Lumina:&lt;br /&gt;
* You can use Function F to ..., &lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Not:&#039;&#039;&#039;&#039;&#039; Function F can be utilized to ...&lt;br /&gt;
* We invite you to email us your comments&lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Not:&#039;&#039;&#039;&#039;&#039; The reader is invited to email Lumina their comments.&lt;br /&gt;
&lt;br /&gt;
If the recipient would otherwise be ambiguous, write for example: &lt;br /&gt;
* Email Lumina your comments. &lt;br /&gt;
&lt;br /&gt;
When the subject isn&#039;t &amp;quot;you&amp;quot;, it&#039;s often &amp;quot;Analytica&amp;quot;. Since this documentation is about Analytica, it&#039;s fine to refer to Analytica as &amp;quot;it&amp;quot; (she doesn&#039;t mind):&lt;br /&gt;
* When you click the button, it shows the dialog box.&lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Not:&#039;&#039;&#039;&#039;&#039; When the user clicks the button, Analytica will display the dialog box.&lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Definitely not:&#039;&#039;&#039;&#039;&#039; When the button is clicked, the dialog box is displayed.&lt;br /&gt;
&lt;br /&gt;
It&#039;s occasionally useful to mention &amp;quot;Analytica&amp;quot; explicitly to emphasize a special Analytica way of doing things to contrast it to other languages and software:&lt;br /&gt;
* Analytica uses name-based subscripting, instead of position-based subscripting, which is standard in most computer languages.&lt;br /&gt;
&lt;br /&gt;
=== It&#039;s, don&#039;t and common contractions ===&lt;br /&gt;
&lt;br /&gt;
It&#039;s fine to use common contractions like &amp;quot;it&#039;s&amp;quot;, &amp;quot;don&#039;t&amp;quot;, &amp;quot;isn&#039;t&amp;quot; and so on.  They&#039;re a bit faster to read, and convey informality, which is good. We want to avoid academic, government, or corporate-speak.&lt;br /&gt;
&lt;br /&gt;
=== Click, Press, Select ===&lt;br /&gt;
&lt;br /&gt;
* You &#039;&#039;&#039;&#039;&#039;click&#039;&#039;&#039;&#039;&#039; a button or link (not &#039;&#039;click on&#039;&#039;). &lt;br /&gt;
*You &#039;&#039;&#039;&#039;&#039;press&#039;&#039;&#039;&#039;&#039; a menu to see the menu options (the action is to click and hold) &lt;br /&gt;
*You &#039;&#039;&#039;&#039;&#039;select&#039;&#039;&#039;&#039;&#039; a menu option. &lt;br /&gt;
*You also &#039;&#039;&#039;&#039;&#039;select&#039;&#039;&#039;&#039;&#039; a node or text from a text field. &lt;br /&gt;
*You &#039;&#039;&#039;&#039;&#039;press&#039;&#039;&#039;&#039;&#039; (not &#039;&#039;hit &#039;&#039;or &#039;&#039;depress&#039;&#039;) a key or key combination on the keyboard.&lt;br /&gt;
&lt;br /&gt;
* Label web links so that users get a reasonable idea of what they will find on the linked page. &lt;br /&gt;
&lt;br /&gt;
* You never need to write &amp;quot;click this link&amp;quot; or &amp;quot;click here&amp;quot;. People know about clicking links! The browser normally shows hyperlinked text in blue and/or underlined to show that it&#039;s clickable.&lt;br /&gt;
&lt;br /&gt;
===Common words and concepts===&lt;br /&gt;
&lt;br /&gt;
Use short words instead of longer synonyms: &lt;br /&gt;
* &amp;quot;use&amp;quot; is better than &amp;quot;utilize&amp;quot;&lt;br /&gt;
* &amp;quot;let&amp;quot; is better than &amp;quot;allow ... to&amp;quot;.&lt;br /&gt;
* Use long dash (m-dash) or double-dash around examples or interjections (rather than parentheses) -- for example &amp;quot;Use a reducing function -- e.g. Sum or Min -- rather than a transforming function.&amp;quot;&lt;br /&gt;
&lt;br /&gt;
===Also additionally, moreover,and more===&lt;br /&gt;
&lt;br /&gt;
Inexperienced writers often use words like &amp;quot;Also&amp;quot;, &amp;quot;Additionally&amp;quot;, or &amp;quot;Moreover&amp;quot; to start sentences to indicate some link to the preceding sentences. These words are almost always unnecessary and should be deleted. The fact that two sentences come one after the another already implies &amp;quot;Additionally&amp;quot;.&lt;br /&gt;
&lt;br /&gt;
== Analytica terminology  ==&lt;br /&gt;
&lt;br /&gt;
* Capitalize terms used with a special meaning in Analytica -- such as, Variable, Object, Attribute, or Diagram -- to distinguish them from their common meaning, which is often subtly different. &lt;br /&gt;
* There&#039;s no need to capitalize standard computer terms -- like, window, menu, button, mouse, keyboard -- or standard mathematical terms -- like, variable, function, parameter, array -- except when they&#039;re being used with a special Analytica take on the meaning, as for example, &#039;&#039;Variable&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
*  Don&#039;t use &#039;&#039;&#039;&#039;&#039;node&#039;&#039;&#039;&#039;&#039; to mean a &#039;&#039;Variable&#039;&#039; or &#039;&#039;Object&#039;&#039;. A &#039;&#039;&#039;&#039;&#039;node&#039;&#039;&#039;&#039;&#039; is the visual representation in a Diagram of a &#039;&#039;Variable &#039;&#039;or other Class of  &#039;&#039;Object&#039;&#039;. An &#039;&#039;Object&amp;quot; can have multiple nodes -- e.g., the original node and aliases, including input and output nodes. A Variable is just one Class of Object. For views or operations that apply to all classes of Object, use &#039;&#039;Object&#039;&#039; rather than &#039;&#039;Variable&#039;&#039;.  But, do use &#039;&#039;&#039;&#039;&#039;node&#039;&#039;&#039;&#039;&#039; when you are actually referring to a node in a Diagram that you select, create, find, drag, or deletee (including a input or output node).&lt;br /&gt;
&lt;br /&gt;
* Use &#039;&#039;&#039;&#039;&#039;Edition&#039;&#039;&#039;&#039;&#039; of Analytica to mean Player, Professional, {{Developer}}, ADE, ACP, and so on. &lt;br /&gt;
* Use &#039;&#039;&#039;&#039;&#039;Release&#039;&#039;&#039;&#039;&#039; as in Release 5.3. &lt;br /&gt;
* Avoid &#039;&#039;&#039;&#039;&#039;version&#039;&#039;&#039;&#039;&#039; because it can mean either &#039;&#039;Edition&#039;&#039; or &#039;&#039;Release&#039;&#039;.&lt;br /&gt;
&lt;br /&gt;
*&#039;&#039;&#039;ADE&#039;&#039;&#039; and &#039;&#039;&#039;ACP&#039;&#039;&#039; are &#039;&#039;&#039;&#039;&#039;Editions&#039;&#039;&#039;&#039;&#039; of Analytica, just like Professional and {{Developer}}. So we don&#039;t need to say &amp;quot;Analytica and ADE&amp;quot; or &amp;quot;Analytica and ACP&amp;quot; as we have done often in the past. &#039;&#039;&#039;&#039;&#039;Optimizer&#039;&#039;&#039;&#039;&#039; is also an Edition, not an extension or option.&lt;br /&gt;
&lt;br /&gt;
* Use &amp;quot;parameter&amp;quot; &#039;&#039;not &#039;&#039; &amp;quot;argument&amp;quot; for the things listed in parentheses in a call to a function (the &#039;&#039;actual&#039;&#039; parameters), or in the  &#039;&#039;&#039;Parameters&#039;&#039;&#039; attribute of a function (the &#039;&#039;formal&#039;&#039; parameters).&lt;br /&gt;
&lt;br /&gt;
== Lists  ==&lt;br /&gt;
&lt;br /&gt;
*Use a &#039;&#039;&#039;&#039;&#039;bulleted list&#039;&#039;&#039;&#039;&#039;, like this, wherever appropriate.&lt;br /&gt;
&lt;br /&gt;
*Use a &#039;&#039;&#039;&#039;&#039;numbered or lettered list&#039;&#039;&#039;&#039;&#039; only where the items are intrinsically ordered -- e.g. a series of steps that won&#039;t work in a different order:&lt;br /&gt;
&lt;br /&gt;
#Do this&lt;br /&gt;
#Next, do this&lt;br /&gt;
#Finish up by doing this&lt;br /&gt;
&lt;br /&gt;
There&#039;s no need to introduce a list by saying &amp;quot;the following&amp;quot;. A simple colon followed by a list makes it clear without the extra words:&lt;br /&gt;
* These are options for parameter X: (note the colon) &lt;br /&gt;
* &#039;&#039;&#039;&#039;&#039;Not:&#039;&#039;&#039;&#039;&#039; The following are options for parameter X.&lt;br /&gt;
&lt;br /&gt;
* If each item is a single phrase, there&#039;s no need for a period or comma at the end.  But, do use a period if there are multiple sentences, as in this list.&lt;br /&gt;
&lt;br /&gt;
* Order items in a list (or sections in a chapter, or parameters of a function when designing a function) from the easiest or most commonly used to the more complicated and esoteric.  That way, readers scanning down the list will:&lt;br /&gt;
** find what they want sooner on average,&lt;br /&gt;
** read the easy stuff first, preparing them to understand the harder stuff that comes later, only if they need to.&lt;br /&gt;
* Alphabetic ordering is usually pointless online:  If you already know the name of the function (or whatever), which you would need for alphabetic search, you can use &#039;&#039;&#039;Find&#039;&#039;&#039; ctrl+F.&lt;br /&gt;
&lt;br /&gt;
* Avoid making lists with more than about 5 items at the same level. If you have a lot more items, group related items into sublists as a hierarchy. That makes it easier to scan down a list to find what you want.&lt;br /&gt;
&lt;br /&gt;
==Media wiki conventions==&lt;br /&gt;
===Page titles and wiki links===&lt;br /&gt;
&lt;br /&gt;
In Analytica Docs), use Sentence case for page titles. The first word starts with a capital letter. Don&#039;t capitalize the other words unless they are proper nouns (such as Analytica):&lt;br /&gt;
* &#039;&#039;&#039;Document style guide&#039;&#039;&#039;&lt;br /&gt;
* Not:&#039;&#039;&#039; Document Style Guide&#039;&#039;&#039;&lt;br /&gt;
This is important because Mediawiki (the platform for these Analytica docs) is case-sensitive for internal links.&lt;br /&gt;
&lt;br /&gt;
Use singular nouns, not plural:&lt;br /&gt;
* User-defined attribute&lt;br /&gt;
* &#039;&#039;&#039;Not:&#039;&#039;&#039; User-defined Attributes&lt;br /&gt;
&lt;br /&gt;
You can add plurals for internal links by added &amp;quot;s&amp;quot; or other letters after an internal link:&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;[[User-defined attribute]]s&amp;lt;/nowiki&amp;gt; are suitable for creating attributes that do not exist. To create a new [[user-defined attribute]], proceed as follows.&amp;lt;/code&amp;gt; &lt;br /&gt;
There&#039;s no need to rename all existing pages, but please use the suggested style for new pages or when merging multiple pages of similar content.  &lt;br /&gt;
&lt;br /&gt;
To make wiki markup easier to read and edit, use the standard wiki links to other wiki pages, like:&lt;br /&gt;
 &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;[[User-defined attribute]]&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt;&lt;br /&gt;
&#039;&#039;&#039;Never use&#039;&#039;&#039; full urls in internal links, like: &lt;br /&gt;
 &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;[http://docs.analytica.com/index.php?title=User-defined attribute|User-defined attribute]&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Titles of Analytica components, such as names of windows, functions etc ===&lt;br /&gt;
&lt;br /&gt;
Use the same name and capitalization used in the software so that the users will not be confused by different terms.&lt;br /&gt;
&lt;br /&gt;
=== Table of Contents ===&lt;br /&gt;
&lt;br /&gt;
Analytica docs automatically generates a Table of Contents for each page in a panel on the right. &lt;br /&gt;
You can ignore the standard Mediawiki Table of contents code &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;__TOC__&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; .&lt;br /&gt;
&lt;br /&gt;
===Tables===&lt;br /&gt;
Use wikitable format to create a table:&lt;br /&gt;
Precede it by a colon (&amp;lt;code&amp;gt;:&amp;lt;/code&amp;gt;)) to indent the table:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white&amp;quot;&amp;gt;&lt;br /&gt;
:{| class=wikitable&lt;br /&gt;
! &lt;br /&gt;
! Column 1&lt;br /&gt;
! Column 2&lt;br /&gt;
|-&lt;br /&gt;
! Row 1&lt;br /&gt;
| Cell 11&lt;br /&gt;
| Cell 12&lt;br /&gt;
|- &lt;br /&gt;
! Row 2&lt;br /&gt;
| Cell 21&lt;br /&gt;
| Cell 22&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The code above yields this table:&lt;br /&gt;
&lt;br /&gt;
:{| class=wikitable&lt;br /&gt;
! &lt;br /&gt;
! Column 1&lt;br /&gt;
! Column 2&lt;br /&gt;
|-&lt;br /&gt;
! Row 1&lt;br /&gt;
| Cell 11&lt;br /&gt;
| Cell 12&lt;br /&gt;
|- &lt;br /&gt;
! Row 2&lt;br /&gt;
| Cell 21&lt;br /&gt;
| Cell 22&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
See [[Guide to Converting Documents to MediaWiki]] for more.&lt;br /&gt;
&lt;br /&gt;
==Images==&lt;br /&gt;
Use the wiki Upload file functionality to upload image files.&lt;br /&gt;
&lt;br /&gt;
Indent images by one tab (precede by one colon (&amp;lt;code&amp;gt;:&amp;lt;/code&amp;gt;)), as in:&lt;br /&gt;
&lt;br /&gt;
 &amp;lt;pre style=&amp;quot;background:white; border:white&amp;quot;&amp;gt;&lt;br /&gt;
:[[image:ImageFile.png]]&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The wiki syntax for images with centered captions on white background is as follows.&lt;br /&gt;
&lt;br /&gt;
One image:&lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white&amp;quot;&amp;gt;&lt;br /&gt;
:{|border=0&lt;br /&gt;
|bgcolor=white|[[image:ImageFile.png|frame|&amp;lt;center&amp;gt;Image caption.&amp;lt;/center&amp;gt;]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Two images side-by-side:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white&amp;quot;&amp;gt;&lt;br /&gt;
:{| border=&amp;quot;0&amp;quot;&lt;br /&gt;
|bgcolor=white|[[image:ImageFileOne.png|frame|&amp;lt;center&amp;gt;Image caption one&amp;lt;/center&amp;gt;]]&lt;br /&gt;
|bgcolor=white|[[image:ImageFileTwo.png|frame|&amp;lt;center&amp;gt;Image caption two&amp;lt;/center&amp;gt;]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
or &lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white&amp;quot;&amp;gt;&lt;br /&gt;
:{|&lt;br /&gt;
|bgcolor=white|[[File:ImageFileOne.png|thumb|500px|&amp;lt;center&amp;gt;Image caption one&amp;lt;/center&amp;gt;]]&lt;br /&gt;
|bgcolor=white|[[File:ImageFileTwo.png|thumb|500px|&amp;lt;center&amp;gt;Image caption two&amp;lt;/center&amp;gt;]]&lt;br /&gt;
|}&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
For sample images created this way,  see [[Kernel Density Smoothing]] and [[Node Alignment, Sizing, and Spacing]].&lt;br /&gt;
&lt;br /&gt;
==Formulas==&lt;br /&gt;
Indent mathematical formulas by one tab (precede by one colon (&amp;lt;code&amp;gt;:&amp;lt;/code&amp;gt;)) and surround by &amp;lt;code&amp;gt;&amp;lt;nowiki&amp;gt;&amp;lt;math&amp;gt;&amp;lt;/nowiki&amp;gt;&amp;lt;/code&amp;gt; tags, e.g.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white;&amp;quot;&amp;gt;&lt;br /&gt;
:&amp;lt;math&amp;gt;&lt;br /&gt;
E=mc^2&lt;br /&gt;
&amp;lt;/math&amp;gt;&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
which results in&lt;br /&gt;
:&amp;lt;math&amp;gt;&lt;br /&gt;
E=mc^2&lt;br /&gt;
&amp;lt;/math&amp;gt;&lt;br /&gt;
&lt;br /&gt;
For help with mathematical formulas, see the [http://en.wikipedia.org/wiki/Help:Displaying_a_formula Wikipedia help page].&lt;br /&gt;
&lt;br /&gt;
== Other typographic conventions  ==&lt;br /&gt;
&lt;br /&gt;
:{| cellpadding=&amp;quot;2&amp;quot; class=&amp;quot;wikitable&amp;quot;&lt;br /&gt;
|-&lt;br /&gt;
! width=&amp;quot;200pt&amp;quot; | Type of Text &lt;br /&gt;
! width=&amp;quot;300pt&amp;quot; | Typography&lt;br /&gt;
! width=&amp;quot;100pt&amp;quot; | Example&lt;br /&gt;
! width=&amp;quot;300pt&amp;quot; | Wiki Code&lt;br /&gt;
|-&lt;br /&gt;
| Special Analytica term &lt;br /&gt;
| Capitalize and link when used with special Analytica meaning, but not when used in its normal sense.&lt;br /&gt;
| [[Intelligent Arrays]], [[Attributes]]&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;[[Intelligent Arrays]]&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Window title, menus, menu item, dialog box title, panel title, and button label &lt;br /&gt;
| &#039;&#039;&#039;Bold&#039;&#039;&#039; &lt;br /&gt;
| &#039;&#039;&#039;File&#039;&#039;&#039;, &#039;&#039;&#039;Attribute Panel&#039;&#039;&#039;&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;&#039;&#039;&#039;File&#039;&#039;&#039;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Analytica global object identifier or title, including variable or module&lt;br /&gt;
| &#039;&#039;&#039;Bold&#039;&#039;&#039;&lt;br /&gt;
| for example variable &#039;&#039;&#039;X&#039;&#039;&#039;, &#039;&#039;&#039;X&#039;&#039;&#039;&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;&#039;&#039;&#039;X&#039;&#039;&#039;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Label of a user input such as a checkbox&lt;br /&gt;
| &#039;&#039;Italics&#039;&#039; &lt;br /&gt;
| &#039;&#039;Edit Attributes&#039;&#039; setting for the &#039;&#039;&#039;Preferences&#039;&#039;&#039; dialog&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;&#039;&#039;Edit Attributes&#039;&#039;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Key on a keyboard &lt;br /&gt;
| &#039;&#039;Italics&#039;&#039;&lt;br /&gt;
| &amp;quot;Press &#039;&#039;Enter&#039;&#039;&amp;quot;; &#039;&#039;control+e&#039;&#039; &lt;br /&gt;
| &amp;lt;nowiki&amp;gt;Press &#039;&#039;Enter&#039;&#039;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Function name &lt;br /&gt;
| Linked (which bolds functions when on their own page) with trailing parens, &amp;quot;()&amp;quot;. No links needed when embedded in code.&lt;br /&gt;
| [[Sequence]]()&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;[[Sequence]]()&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Formal parameter name -- i.e. the declared name of a function parameter distinct from the actual parameter, which is the value or expression passed in a call to a function &lt;br /&gt;
| Use lowercase or &amp;quot;camelCase&amp;quot;; surround by by double angled brackets «a», except when inside formal parameter declaration (within parens after function name). Italicize optional parameters when inside parentheses. Code (courier) font so &amp;lt;code&amp;gt;I&amp;lt;/code&amp;gt; appears distinct from the number 1.&lt;br /&gt;
| &amp;lt;code&amp;gt;[[Sort]](a, I, &#039;&#039;keyIndex&#039;&#039; ); «a», «I», «keyIndex»&amp;lt;/code&amp;gt;&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;«a»&amp;lt;/nowiki&amp;gt;&#039;&#039;How does one find these characters?&#039;&#039;&lt;br /&gt;
&lt;br /&gt;
- Install English (United States) International keyboard&lt;br /&gt;
&lt;br /&gt;
- for « use AltGr (Right-Alt) + [&lt;br /&gt;
&lt;br /&gt;
- for » use AltGr (Right-Alt) + ] &lt;br /&gt;
|-&lt;br /&gt;
| parameter qualifier&lt;br /&gt;
| Capitalize to distinguish from formal parameter names &lt;br /&gt;
| Bool, Text, Number&lt;br /&gt;
| &amp;lt;nowiki&amp;gt;Bool&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Code and script examples, expressions and variable definitions &lt;br /&gt;
| &amp;lt;code&amp;gt;Fixed width font, indented rows&amp;lt;/code&amp;gt; &lt;br /&gt;
| &amp;lt;tt&amp;gt;MDTable(T,Rows,Cols,[Car_type,Mpg],&#039;average&#039;,&#039;n/a&#039;)&amp;lt;/tt&amp;gt;&lt;br /&gt;
| This can be done by&lt;br /&gt;
&lt;br /&gt;
1) using colons (for indentation) and code tags:&lt;br /&gt;
&lt;br /&gt;
&amp;lt;nowiki&amp;gt;:&amp;lt;code&amp;gt;MDTable(T, Rows, Cols, [Car_type, Mpg], &#039;average&#039;, &#039;n/a&#039;)&amp;lt;/code&amp;gt;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
2) using colons and &amp;lt;nowiki&amp;gt;&amp;lt;tt&amp;gt;&amp;lt;/nowiki&amp;gt; tags: &lt;br /&gt;
&lt;br /&gt;
&amp;lt;nowiki&amp;gt;:&amp;lt;/nowiki&amp;gt;&amp;lt;nowiki&amp;gt;&amp;lt;tt&amp;gt;MDTable(T, Rows, Cols, [Car_type, Mpg], &#039;average&#039;, &#039;n/a&#039;)&amp;lt;/tt&amp;gt;&amp;lt;/nowiki&amp;gt; &lt;br /&gt;
&lt;br /&gt;
3) putting a space at the beginning of the line (the code will be displayed in a gray box): &lt;br /&gt;
&lt;br /&gt;
&amp;lt;nowiki&amp;gt;&amp;amp;nbsp;&amp;lt;/nowiki&amp;gt;MDTable(T, Rows, Cols, [Car_type, Mpg], &#039;average&#039;, &#039;n/a&#039;)&lt;br /&gt;
&lt;br /&gt;
4) surrounding the code by &amp;lt;nowiki&amp;gt;&amp;lt;pre&amp;gt; tags (preferred method with multi-line code):&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;nowiki&amp;gt;&amp;lt;pre style=&amp;quot;background:white; border:white; margin-left: 1em;&amp;quot;&amp;gt;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
MDTable(T, Rows, Cols, [Car_type, Mpg], &#039;average&#039;, &#039;n/a&#039;)&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
|Error message examples&lt;br /&gt;
|&#039;&#039;&amp;lt;code&amp;gt;Fixed width font in italics, indented rows &amp;lt;/code&amp;gt;&#039;&#039;&lt;br /&gt;
|&#039;&#039;&amp;lt;code&amp;gt;You cannot evaluate a call to RunConsoleProcess directly from an input variable.&amp;lt;/code&amp;gt;&#039;&#039;&lt;br /&gt;
|This can be done by&lt;br /&gt;
&lt;br /&gt;
1) using colons (:) in front of every row for indentation and &amp;lt;nowiki&amp;gt;&amp;lt;code&amp;gt; tags around every row:&amp;lt;/nowiki&amp;gt;&amp;lt;nowiki&amp;gt;:&amp;lt;code&amp;gt;&#039;&#039;&amp;lt;/nowiki&amp;gt;You cannot evaluate a call to RunConsoleProcess directly from an input variable.&amp;lt;nowiki&amp;gt;&#039;&#039;&amp;lt;/nowiki&amp;gt;&amp;lt;nowiki&amp;gt;&amp;lt;/code&amp;gt;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
2) using &amp;lt;nowiki&amp;gt;&amp;lt;pre&amp;gt;tags around text (preferred method with multi-line error messages):&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
&amp;lt;nowiki&amp;gt;&amp;lt;pre style=&amp;quot;background:white; border:white; margin-left: 1em; font-style:italic&amp;quot;&amp;gt;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
&lt;br /&gt;
You cannot evaluate a call to RunConsoleProcess directly from an input variable.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
|-&lt;br /&gt;
| Document name &lt;br /&gt;
| &#039;&#039;Italics and Capitalized&#039;&#039;&lt;br /&gt;
| &#039;&#039;User Guide&#039;&#039; &lt;br /&gt;
| &amp;lt;nowiki&amp;gt;&#039;&#039;User Guide&#039;&#039;&amp;lt;/nowiki&amp;gt;&lt;br /&gt;
|}&lt;br /&gt;
&lt;br /&gt;
== Conventions for explaining functions and their parameters ==&lt;br /&gt;
&lt;br /&gt;
The heading for the section of documentation on a function should contain the name of function and the most common parameters, without qualifiers. Don&#039;t include optional parameters unless they are usually used. &lt;br /&gt;
&lt;br /&gt;
* Function definition sections should use a Heading2 paragraph tag for the function title for the section.&lt;br /&gt;
&lt;br /&gt;
In some cases, we include several related functions in one section. We should then include them all in the same heading, e.g. &lt;br /&gt;
&lt;br /&gt;
===   PDF(x) and CDF(x) ===&lt;br /&gt;
&lt;br /&gt;
Conventions: Use the recommended name for each qualifier rather than its deprecated synonyms. Omit &amp;quot;Atom&amp;quot; which is of more interest to the implementer than the user of a function. &lt;br /&gt;
&lt;br /&gt;
Use these conventions for naming parameters that don&#039;t have otherwise meaningful names, to indicate what type is expected: &lt;br /&gt;
&lt;br /&gt;
*x, y, z: Numbers that may be scalar or array-valued. &lt;br /&gt;
*I, J, K: Identifiers of Index variables &lt;br /&gt;
*t, t1, t2: Text values (numbers will be coerced to text) &lt;br /&gt;
*a, b, c: An expression that may evaluate to anything: Scalar or array, number or text, NAN, or reference. &lt;br /&gt;
*p, q: A probability, a number between 0 and 1. &lt;br /&gt;
*r: A reference &lt;br /&gt;
*v: Identifier of variable. &lt;br /&gt;
*expr: An expression, which is not evaluated before calling function&lt;br /&gt;
*obj or o: A handle to an an Object (of any Class) &lt;br /&gt;
*attrib: The identifier of an Attribute&lt;br /&gt;
&lt;br /&gt;
Most named parameters in the User Guide that are not meaningful (unlike mean, min, mode) already follow these conventions. If any do not, we should consider changing them so they do. &lt;br /&gt;
&lt;br /&gt;
*Provide a page explaining these conventions, linked to from every function description.&lt;br /&gt;
&lt;br /&gt;
Each function description should have these sections (where appropriate): &lt;br /&gt;
&lt;br /&gt;
*Title of section (usually 3= level) includes name of function and most common parameters. &lt;br /&gt;
*Brief description of at least one simple case use. &lt;br /&gt;
*Example(s) &lt;br /&gt;
*Requirements: Expectations or constraints on parameters. &lt;br /&gt;
*If there are many parameters, list them as a bulleted list, explaining each one&lt;br /&gt;
*More complex examples&lt;br /&gt;
*Syntax: Near bottom using (slightly cleaned) declaration syntax.&lt;br /&gt;
&lt;br /&gt;
In this wiki, each section describing a function should contain a complete spec of its parameters, usually near the end of the section, with a format like this:&amp;lt;br&amp;gt;&amp;amp;nbsp;[[Parameter types]]: MakeDate(year: Coerce Atomic Positive; month, day: Optional Coerce Atomic Positive)&amp;lt;br&amp;gt;Note that the subhead [[Parameter types]] is a link to a page that explains the meaning of the parameter types and qualifiers.&lt;br /&gt;
&lt;br /&gt;
=== Guidelines for Analytica Docs ===&lt;br /&gt;
==== Organizing documents with multiple pages ====&lt;br /&gt;
&lt;br /&gt;
* Organize the pages into a set of &amp;quot;documents&amp;quot;, such as [[Analytica Tutorial|Tutorial]], [[Analytica User Guide|User Guide]], [[Analytica Optimizer Guide|Optimizer Guide]], [[ADE User Guide]], Analytica Reference Guide, Analytica FAQs, Analytica libraries.&lt;br /&gt;
&lt;br /&gt;
* Organize each document or section as a tree hierarchy -- i.e., where each page has a single parent -- although there may, of course, be many cross-references. A tree makes it easier for you to understand the organization, and go through all pages at a given level. It also makes it easier to generate a sequential PDF or printed document if we need to.&lt;br /&gt;
&lt;br /&gt;
* Show ancestor list (a.k.a. &amp;quot;bread crumbs&amp;quot;) at the top of each page -- i.e. a list of links to parent, grandparent etc. For example, page [[SolverInfo]] should show&lt;br /&gt;
[[Analytica Reference Guide]] &amp;gt; [[Enhancements to Optimizer in Analytica 4.0]]&lt;br /&gt;
This helps you see where you are and lets you quickly move up one or more levels.&lt;br /&gt;
&lt;br /&gt;
==== Organizing a page ====&lt;br /&gt;
&lt;br /&gt;
* Keep page names as short as reasonable.&lt;br /&gt;
&lt;br /&gt;
* Show ancestor list (see above)&lt;br /&gt;
&lt;br /&gt;
* Common subheads:&lt;br /&gt;
** Examples&lt;br /&gt;
** Syntax&lt;br /&gt;
** Tips&lt;br /&gt;
** See also&lt;br /&gt;
** History: Summarizes when a new feature was introduced or modified. Move all old links like &amp;quot;New in Release 5.1&amp;quot; when we&#039;re up to Release 5.3 to the History section (or just delete them).&lt;br /&gt;
&lt;br /&gt;
** Enhancement requests&lt;br /&gt;
** Documentation requests&lt;br /&gt;
&lt;br /&gt;
====Categories====&lt;br /&gt;
&lt;br /&gt;
The category indexes are a big benefit of MediaWiki. You can specify one or more Categories for each page. The page then automatically appears in the corresponding Category page. For example, for a page on [[MdArrayToTable]] contains the code&lt;br /&gt;
 [[:Category:Array Flattening Functions]]&lt;br /&gt;
No matter where you locate this code, it shows this at the bottom of the page:&lt;br /&gt;
 [[:Category: Array Flattening Functions]]&lt;br /&gt;
And it inserts  [[MdArrayToTable]] in the page [[:Category:Array Flattening Functions]]&lt;br /&gt;
This makes it easy for readers to find all the array-flattening functions.&lt;br /&gt;
&lt;br /&gt;
You can list multiple categories:&lt;br /&gt;
  [[:Category: Array Flattening Functions]], [[:Category: Array Functions]], [[:Category: Table functions]]&lt;br /&gt;
&lt;br /&gt;
If you want to categorize two or more items with different categories, on the same page, create a redirect page for each item with the item&#039;s name. Include a category markup in the redirect page. This might look like this:&lt;br /&gt;
&amp;lt;pre&amp;gt;&lt;br /&gt;
#REDIRECT [[Functions To Read Excel Worksheets#SpreadsheetCell]]&lt;br /&gt;
[[Category:Database Functions]]&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
Put the #REDIRECT line first, with the category tag(s) after it. MediaWiki only recognizes a redirect on the page&#039;s first line: if a category tag comes first, the page displays as an ordinary page instead of redirecting. (On normal, non-redirect pages, keep the category tags at the top.) When linking to an item that lives on a page with other items, link to the redirect page, i.e., use &amp;lt;pre&amp;gt;[[SpreadsheetCell]]&amp;lt;/pre&amp;gt;, not &amp;lt;pre&amp;gt;[[Functions To Read Excel Worksheets#SpreadsheetCell]]&amp;lt;/pre&amp;gt;.&lt;br /&gt;
&lt;br /&gt;
If the heading within the page you redirect to has extra stuff in the heading, for example:&lt;br /&gt;
&amp;lt;pre&amp;gt;===SpreadsheetCell(wb, sheet, col, row)===&amp;lt;/pre&amp;gt;&lt;br /&gt;
Make a simple anchor tag using a div tag such as&lt;br /&gt;
&amp;lt;pre&amp;gt;===&amp;lt;div id=&amp;quot;SpreadsheetCell&amp;quot;&amp;gt;SpreadsheetCell(wb, sheet, col, row)&amp;lt;/div&amp;gt;===&amp;lt;/pre&amp;gt;&lt;br /&gt;
This way you can use just &amp;quot;#SpreadsheetCell&amp;quot; in the redirect URL.&lt;br /&gt;
&lt;br /&gt;
==History==&lt;br /&gt;
&lt;br /&gt;
* Many features have links from and to a &amp;quot;What&#039;s new&amp;quot; page for the release in which they were first introduced or modified, e.g. [[What&#039;s new in Analytica 5.0?]].&lt;br /&gt;
* Ideally, links to a &amp;quot;What&#039;s new&amp;quot; page should only exist for the most recent release -- e.g. [[What&#039;s new in Analytica 5.4?]]. Ancient history is of little interest to 99% of readers.&lt;br /&gt;
* So, when working on a page, please move information about when a feature was introduced or modified for older releases to the &#039;&#039;&#039;History&#039;&#039;&#039; section at the end of each page.&lt;br /&gt;
&lt;br /&gt;
==See Also==&lt;br /&gt;
Every page should have a &#039;&#039;&#039;See Also&#039;&#039;&#039; section, with links to pages on related topics that someone reading this page may find useful. In this case:&lt;br /&gt;
&lt;br /&gt;
* [[Analytica model style guide]] for Analytica code and model documentation&lt;br /&gt;
* [[Guide to Converting Documents to MediaWiki]]&lt;br /&gt;
* [[Ana:Pages needing work]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=NextInTabOrder&amp;diff=65931</id>
		<title>NextInTabOrder</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=NextInTabOrder&amp;diff=65931"/>
		<updated>2026-11-20T00:10:16Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Customizing the Tabbing order on a Diagram]]&lt;br /&gt;
[[category:Attributes]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=LocalIndex..Do&amp;diff=65930</id>
		<title>LocalIndex..Do</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=LocalIndex..Do&amp;diff=65930"/>
		<updated>2026-11-20T00:10:15Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[MetaIndex..Do]]&lt;br /&gt;
[[category:Evaluation Functions]]&lt;br /&gt;
[[category:Meta-Inference Functions]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=Local..Do&amp;diff=65929</id>
		<title>Local..Do</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=Local..Do&amp;diff=65929"/>
		<updated>2026-11-20T00:10:15Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[MetaVar..Do]]&lt;br /&gt;
[[category:Evaluation Functions]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=Gauss_Quadrature_Pts&amp;diff=65928</id>
		<title>Gauss Quadrature Pts</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=Gauss_Quadrature_Pts&amp;diff=65928"/>
		<updated>2026-11-20T00:10:15Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Legendre Library#Gauss_Quadrature_Pts]]&lt;br /&gt;
[[Category:Integration (Quadrature) functions]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=IsList&amp;diff=65927</id>
		<title>IsList</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=IsList&amp;diff=65927"/>
		<updated>2026-11-20T00:10:14Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Data Type Functions#Function IsList]]&lt;br /&gt;
[[category:Data Type Functions]]&lt;br /&gt;
[[category:Functions returning information about arrays]]&lt;br /&gt;
[[category:Meta-Inference Functions]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=Contains&amp;diff=65926</id>
		<title>Contains</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=Contains&amp;diff=65926"/>
		<updated>2026-11-20T00:10:14Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Move #REDIRECT to the first line (MediaWiki ignores it after the category tags)&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt;#REDIRECT [[Objects_and_Their_Attributes_-_Part_2_of_3#Computed_Attributes]]&lt;br /&gt;
[[Category:Attributes]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
	<entry>
		<id>https://docs.analytica.com/index.php?title=GetProcessInfo&amp;diff=63860</id>
		<title>GetProcessInfo</title>
		<link rel="alternate" type="text/html" href="https://docs.analytica.com/index.php?title=GetProcessInfo&amp;diff=63860"/>
		<updated>2026-04-17T15:46:39Z</updated>

		<summary type="html">&lt;p&gt;Lchrisman+opus: Added new 7.1 options: Current Monitor Rect, Current Monitor Work Rect, Number of Monitors, Monitor N Rect, Monitor N Work Rect&lt;/p&gt;
&lt;hr /&gt;
&lt;div&gt; [[Category:System Functions]]&lt;br /&gt;
[[Category: Memory management]]&lt;br /&gt;
{{ReleaseBar}}&lt;br /&gt;
&lt;br /&gt;
[[GetProcessInfo]] can give you information about the current Analytica or [[ADE]] process, such as user name, computer, name, memory in use, number of processors available, number of objects in the model, and a whole lot more. from the Windows operating system,&lt;br /&gt;
&lt;br /&gt;
== Types of information  ==&lt;br /&gt;
&lt;br /&gt;
[[GetProcessInfo]] returns information about the current Analytica or [[ADE]] process from the Windows operating system, according to which of these texts you pass as the «item» parameter:&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Process ID&amp;quot;&amp;lt;/code&amp;gt; -- returns the Process ID, or Pid, for the current process.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Thread ID&amp;quot;&amp;lt;/code&amp;gt; -- returns the Id of the Analytica/ADE thread.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Priority&amp;quot;&amp;lt;/code&amp;gt; -- returns the priority of the Analytica/ADE thread.  The following values are possible (defined by the Windows operating system):&lt;br /&gt;
::*&amp;lt;code&amp;gt;-15&amp;lt;/code&amp;gt; : Idle only&lt;br /&gt;
::*&amp;lt;code&amp;gt;-2&amp;lt;/code&amp;gt; : lowest priority&lt;br /&gt;
::*&amp;lt;code&amp;gt;-1&amp;lt;/code&amp;gt; : below normal&lt;br /&gt;
::*&amp;lt;code&amp;gt;0&amp;lt;/code&amp;gt; : normal priority&lt;br /&gt;
::*&amp;lt;code&amp;gt;1&amp;lt;/code&amp;gt; : Above normal&lt;br /&gt;
::*&amp;lt;code&amp;gt;2&amp;lt;/code&amp;gt; : Highest priority&lt;br /&gt;
::*&amp;lt;code&amp;gt;15&amp;lt;/code&amp;gt;: Critical priority&lt;br /&gt;
::*&amp;lt;code&amp;gt;31&amp;lt;/code&amp;gt;: Real-time priority&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Computer Name&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;User Name&amp;quot;&amp;lt;/code&amp;gt;: Windows login name&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;User Identity&amp;quot;&amp;lt;/code&amp;gt;: User name in ACP, or Windows login name in DTA.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Windows Version&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Windows SP&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Windows Build&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Abort Event Object&amp;quot;&amp;lt;/code&amp;gt; { ADE only }.  Name of global Event object for ADE project that can be used to send ADE a break signal to abort the current computation.&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;ENV:&#039;&#039;«name»&#039;&#039;&amp;quot;&amp;lt;/code&amp;gt;: Retrieves the value for the environment variable «name»&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Environment Variables&amp;quot;&amp;lt;/code&amp;gt;: List of all Environment variables&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Command Line&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Analytica Path&amp;quot;&amp;lt;/code&amp;gt;: Full file path to the &#039;&#039;Analytica.exe, Ade.exe&#039;&#039;, or &#039;&#039;Ade.dll&#039;&#039; file being run.&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Working Set Size&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Working Set Max&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Working Set Min&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Working Set Flags&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt; &amp;quot;Working Set Peak&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Private Bytes&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Total RAM&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Free RAM&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Total Virtual&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Max Address Space&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Memory Load&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Total Free Memory&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Page Fault Count&amp;quot;&amp;lt;/code&amp;gt;&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Avail Virtual&amp;quot;&amp;lt;/code&amp;gt; &lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Processor #&amp;quot;&amp;lt;/code&amp;gt;: On a multi-core computer, the processor currently running the current evaluation.  This changes with time.&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Affinity Mask&amp;quot;&amp;lt;/code&amp;gt;: A list of which processors the operating system will allow Analytica&#039;s evaluation to run on.&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Num Processors&amp;quot;&amp;lt;/code&amp;gt;: The number of processors the Analytica process is allowed to run on. &lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Num Sys Processors&amp;quot;&amp;lt;/code&amp;gt;: The total number of processors on this computer in the current processor group. Always &amp;lt;=64.{{Release|6.0||&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Num cores&amp;quot;&amp;lt;/code&amp;gt;: The total number of processors on this computer in all [https://docs.microsoft.com/en-us/windows/win32/procthread/processor-groups processor groups]. (Typically the same as &amp;lt;code&amp;gt;&amp;quot;Num Sys Processors&amp;quot;&amp;lt;/code&amp;gt; on computers with 64 cores or less, but can be greater than 64 on very high-end servers).}}&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;User Objects&amp;quot;&amp;lt;/code&amp;gt;: Number of objects in use (variable nodes, local indexes, etc) by a model&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Total Objects&amp;quot;&amp;lt;/code&amp;gt;: Number of objects in use including both user objects and built-in system objects.&lt;br /&gt;
: &amp;lt;code&amp;gt;&amp;quot;Free Objects&amp;quot;&amp;lt;/code&amp;gt;: Number of free &amp;quot;slots&amp;quot; still available for additional objects.{{Release|6.5||&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Application Rect&amp;quot;&amp;lt;/code&amp;gt;: Returns width, height, top, left, as 4 return values, describing the screen coordinates of the desktop Analytica application window. Returns Null in ADE. &lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Desk Rect&amp;quot;&amp;lt;/code&amp;gt;: Returns width, height, x,y, as 4 return values, describing the rectangle within the desktop application where MDI windows can be. This rectangle starts below the toolbar, and does not include application boundaries.}}{{Release|1=7.0|2=|3=&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Screenshot&amp;quot;&amp;lt;/code&amp;gt;: Returns an image of the Analytica desktop application window (at the time the function call is evaluated).}}{{Release|1=7.1|2=|3=&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Current Monitor Rect&amp;quot;&amp;lt;/code&amp;gt;: Returns width, height, x, y, as 4 return values, describing the screen coordinates of the monitor that the Analytica application window is currently on. Returns Null in ADE.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Current Monitor Work Rect&amp;quot;&amp;lt;/code&amp;gt;: Returns width, height, x, y, as 4 return values, describing the work area (excluding taskbar) of the monitor that the Analytica application window is currently on. Returns Null in ADE.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Number of Monitors&amp;quot;&amp;lt;/code&amp;gt;: The number of monitors connected to the system.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Monitor &#039;&#039;N&#039;&#039; Rect&amp;quot;&amp;lt;/code&amp;gt;: Returns width, height, x, y, as 4 return values, describing the screen coordinates of the &#039;&#039;N&#039;&#039;th monitor (1-based). Replace &#039;&#039;N&#039;&#039; with any integer from 1 to the value of &amp;lt;code&amp;gt;&amp;quot;Number of Monitors&amp;quot;&amp;lt;/code&amp;gt;. For example, &amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Monitor 2 Rect&amp;quot;)&amp;lt;/code&amp;gt; returns the rectangle of the 2nd monitor.&lt;br /&gt;
:&amp;lt;code&amp;gt;&amp;quot;Monitor &#039;&#039;N&#039;&#039; Work Rect&amp;quot;&amp;lt;/code&amp;gt;: Like &amp;lt;code&amp;gt;&amp;quot;Monitor &#039;&#039;N&#039;&#039; Rect&amp;quot;&amp;lt;/code&amp;gt; but returns the work area (excluding taskbar) of the &#039;&#039;N&#039;&#039;th monitor. For example, &amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Monitor 1 Work Rect&amp;quot;)&amp;lt;/code&amp;gt;.}}&lt;br /&gt;
&lt;br /&gt;
== Examples ==&lt;br /&gt;
=== Process ID ===&lt;br /&gt;
Knowing the Process ID makes it possible to differentiate between multiple instances of Analytica or [[ADE]] in the Windows Task Manager.  &lt;br /&gt;
:&amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Process ID&amp;quot;) &amp;amp;rarr; 4117&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Reading the command line ===&lt;br /&gt;
:&amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Command Line&amp;quot;) &amp;amp;rarr; &#039;&amp;quot;C:\Program Files\Lumina\Analytica.exe&amp;quot; &amp;quot;C:\My Models\Costs.ana&amp;quot;&#039;&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
See [[Analytica Command Line]] for a list of valid command line parameters recognized by Analytica.&lt;br /&gt;
&lt;br /&gt;
=== Reading Environment Variables ===&lt;br /&gt;
Obtain a list of all environment variables:&lt;br /&gt;
:&amp;lt;code&amp;gt;Index EnvVarName := GetProcessInfo(&amp;quot;Environment Variables&amp;quot;);&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Env:&amp;quot;&amp;amp;EnvVarName)&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Getting PID from ADE (C#) ===&lt;br /&gt;
:&amp;lt;code&amp;gt;CAEngine ade = new CAEngine();&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;CAObject V = ade.CreateObject(&amp;quot;V&amp;quot;, &amp;quot;variable&amp;quot;);&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;V.SetAttribute(&amp;quot;definition&amp;quot;, &amp;quot;GetProcessInfo(\&amp;quot;Process ID\&amp;quot;)&amp;quot;);&amp;lt;/code&amp;gt;&lt;br /&gt;
:&amp;lt;code&amp;gt;string pInfoResult = V.Result().ToString();&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Aborting an in-progress evaluation in ADE ===&lt;br /&gt;
To abort a computation in [[ADE]], your program must obtain a HANDLE to the &#039;&#039;abort event object&#039;&#039;.  In order to obtain this, you need to obtain the name of this object from ADE.  You get this by calling &amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Abort Event Object&amp;quot;)&amp;lt;/code&amp;gt;.  You then use the Windows Platform SDK routine OpenEvent to get the handle to this object.  When you want to abort an in-process computation, you set this event.  Generally your application that uses ADE will need to be multi-threaded, so that one thread calls ADE, the other thread detects the signal to abort the computation (the signal might be a user pressing &#039;&#039;Ctrl+Break&#039;&#039;, for example).&lt;br /&gt;
&lt;br /&gt;
&amp;lt;pre style=&amp;quot;background:white; border:white; margin-left: 1em;&amp;quot;&amp;gt;&lt;br /&gt;
C++ example:&lt;br /&gt;
&lt;br /&gt;
    /* From first application thread, which uses ADE: */&lt;br /&gt;
    #include &amp;lt;windows.h&amp;gt;&lt;br /&gt;
    #import &amp;quot;ADE.exe&amp;quot;&lt;br /&gt;
    using namespace ADE4;&lt;br /&gt;
    ...&lt;br /&gt;
    GLOBAL HEVENT hAbort;&lt;br /&gt;
    ...&lt;br /&gt;
    void main() &lt;br /&gt;
    {&lt;br /&gt;
        ...&lt;br /&gt;
        CAEngine* pAde = new CAEngine();&lt;br /&gt;
        pAde-&amp;gt;SendCommand(&amp;quot;GetProcessInfo(&#039;Abort Event Object&#039;)&amp;quot;);&lt;br /&gt;
        _bstr_t abortObjName = pAde-&amp;gt;get_OutputBuffer();&lt;br /&gt;
        hAbort = OpenEvent(EVENT_MODIFY_STATE,/*bInherit*/FALSE,abortObjName);&lt;br /&gt;
        ...&lt;br /&gt;
        CreateThread(..., MonitorForBreak,... );&lt;br /&gt;
        CTable* pResult = pAde-&amp;gt;Get(&amp;quot;X&amp;quot;)-&amp;gt;ResultTable();  /* Initiate a very long computation */&lt;br /&gt;
        if (pAde-&amp;gt;get_ErrorCode() == 78) {&lt;br /&gt;
             /* The computation was aborted before completion */&lt;br /&gt;
             ...&lt;br /&gt;
        }&lt;br /&gt;
        ...&lt;br /&gt;
    }&lt;br /&gt;
    &lt;br /&gt;
    DWORD WINAPI MonitorForBreak( LPVOID )&lt;br /&gt;
    {&lt;br /&gt;
         /* This routine detects a signal to break the computation.  Maybe it is a user-keypress,&lt;br /&gt;
          * or other UI interaction. */&lt;br /&gt;
         if (DetectUserWantsToAbort()) {&lt;br /&gt;
             SetEvent(hAbort);                   /* Causes the abort */&lt;br /&gt;
         }&lt;br /&gt;
    }&lt;br /&gt;
&amp;lt;/pre&amp;gt;&lt;br /&gt;
&lt;br /&gt;
=== Memory Information ===&lt;br /&gt;
The Analytica process that evaluates your model may end up using a lot of memory.  The operating system keeps some of that memory in RAM, and swaps some of it out to virtual memory.  Accessing RAM is fast, while accessing virtual memory is much slower.  Windows makes various tradeoffs with what other programs are running on your computer to decide how much of the Analytica process to keep in RAM.  The amount of RAM to devote to Analytica is called its &#039;&#039;working set&#039;&#039;.  When the working set is much smaller that the available RAM, other applications on your computer will respond well (since they can use that RAM), but Analytica may run slowly.  If the working set is close to the amount of available RAM, then Analytica gets to make more use of fast RAM, but other applications, and the Windows UI, may get very slow, since they will then need to switch in and out of memory.&lt;br /&gt;
&lt;br /&gt;
&amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Working Set Max&amp;quot;)&amp;lt;/code&amp;gt; and &amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Working set Min&amp;quot;)&amp;lt;/code&amp;gt; return the minimum and maximum working set size, in bytes, currently imposed by Windows on the Analytica process.  &amp;lt;code&amp;gt;GetProcessInfo(&amp;quot;Working Set Flags&amp;quot;)&amp;lt;/code&amp;gt; returns an integer containing flags, indicating whether Windows is allowed to alter these limits as the process uses more or less memory.  The flags are the following numbers added together:&lt;br /&gt;
* &amp;lt;code&amp;gt;1&amp;lt;/code&amp;gt; = Analytica is guaranteed at least the minimum working set.&lt;br /&gt;
* &amp;lt;code&amp;gt;2&amp;lt;/code&amp;gt; = Windows may reduce Analytica&#039;s working set below the minimum value when memory demands are high&lt;br /&gt;
* &amp;lt;code&amp;gt;4&amp;lt;/code&amp;gt; = Windows will not allocate more than the indicated working set max.&lt;br /&gt;
* &amp;lt;code&amp;gt;8&amp;lt;/code&amp;gt; = Windows may give Analytica more than the &amp;lt;code&amp;gt;Working Set Max&amp;lt;/code&amp;gt; when memory demands from other applications is low.&lt;br /&gt;
&lt;br /&gt;
The &amp;lt;code&amp;gt;&amp;quot;Avail Virtual&amp;quot;&amp;lt;/code&amp;gt; option returns the number that Windows reports as the theoretical maximum amount of memory available to all processes running on the operating system, including both RAM and page file space.  However, the number isn&#039;t very meaningful or reliable, as Windows often reports a number that far exceeds the amount of available hard disk space (for example, in Windows x64, a number of 8.8 TeraBytes is reported), and in 32-bit processes on Windows x64, the huge number seems to be wrap at 4GB, resulting in a nonesense (and often very small) number.&lt;br /&gt;
&lt;br /&gt;
{{Release|1=6.5|2=|3=&lt;br /&gt;
== Application window coordinates == &lt;br /&gt;
&#039;&#039;new in [[Analytica 6.5]]&#039;&#039;&lt;br /&gt;
:&amp;lt;code&amp;gt;[[Local]] (width, height, left, top) := [[GetProcessInfo]]( &#039;Application Rect&#039;);&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This gets the rectangle, in screen coordinates, of the desktop application.  From ADE, or ACP when there is no dual desktop UI running, returns Null.&lt;br /&gt;
&lt;br /&gt;
:&amp;lt;code&amp;gt;[[Local]](width, height) := [[GetProcessInfo]](&#039;Desk Rect&#039;);&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
This gets the size of the desk, the rectangle within the application where diagram windows, object window, result windows, the outliner, Assista window, etc. reside. This desk rectangle starts below the toolbar. You can also get the location:&lt;br /&gt;
&lt;br /&gt;
:&amp;lt;code&amp;gt;[[Local]](width, height, x, y) := [[GetProcessInfo]](&#039;Desk Rect&#039;);&amp;lt;/code&amp;gt;&lt;br /&gt;
&lt;br /&gt;
The x,y location coordinate is relative to the application window.&lt;br /&gt;
}}&lt;br /&gt;
==History==&lt;br /&gt;
This function was introduced in [[What&#039;s new in Analytica 4.0?|Analytica 4.0]].&lt;br /&gt;
&lt;br /&gt;
==See Also==&lt;br /&gt;
* [[Working Set Size]]&lt;br /&gt;
* [[Memory usage and management]]&lt;/div&gt;</summary>
		<author><name>Lchrisman+opus</name></author>
	</entry>
</feed>