Internal:Reorganizing the wiki
See Internal: Contents of Original Guides for Tutorial, User Guide, and Optimizer Guide chapters and sections in their original form (as of Jan 20 2016. Below is the outline with proposed reorgs.
Internal: Improvements to the Wiki
This page proposes changes to the organization of the wiki content recently imported from PDF documents designed to make it easier for users to find what they want. The main changes are:
- Remove "noise" words from page titles, like "Using", "Creating", "Working with", or "Building". These were nice in the original docs, but interfere with search process here where the feature or concept name is key.
- Where it says to move a section within or between chapters, required changes include:
- Move it to the new place in every Contents list page, including the Documents contents, and Chapter contents as needed.
- Adjust the next and previous links for this page and its old and new preceding and next pages.
- Add higher level sections for the User Guide that group sections together
Internal: ACP Wiki reorg
Draft new home page
Analytica basics
- Introduction: About Analytica
- Examining a Model
- Result Tables and Graphs
- Parametric analysis
- Create and edit a model
- Building Effective Models
- Creating Lucid Influence Diagrams ->
- Formatting Numbers, Tables, and Graphs
Definitions and expressions
- Creating and Editing Definitions Rename to Definitions
- Done, BB
- Using Expressions Rename to Numbers, Booleans, operators, and expressions
- Renamed to Expressions to keep the titles short and to exclude noise words (MH/BB)
- Other Functions Rename Text, Date, Math, and Financial Functions move here from below
- Done, BB
- Dynamic Simulation move here from below
- Decided not to move because it assumes the knowledge of arrays and indexes that would have to be explained earlier (MH/BB)
Interfaces for End Users
- Creating Interfaces for End Users rename to User Interfaces for End Users
- Done, BB
- Analytica Cloud Player (ACP)
- Promote ACP to be a chapter level from section in the above chapter
- Done, BB
- Add in other ACP pages as sections. Karen please review other ACP pages, identify any duplication with this page, and propose how to make them sections for the ACP section.
- Promote ACP to be a chapter level from section in the above chapter
Arrays and Indexes
- Other Functions Rename Text, Date, Math, and Financial Functions
- Move from here to "Definitions and Expressions" section
- Done, BB
Uncertainty, probability, and statistics
- Dynamic Simulation move up to section above on "Definitions and expression"
- Decided not to move (MH/BB)
Advanced features
- Importing, Exporting, and OLE Linking Data Rename to Integration with data and applications
- Done, BB
- Working with Large Models
- Building Functions and Libraries rename as "User-defined Functions and Libraries"
- Done, BB
- Procedural Programming
- Analytica Enterprise
- Appendices
Analytica Tutorial
- Add a redirect page to this from Tutorial
- Done
- About Analytica -> change page title to Introducing the Analytica Tutorial
- The "How to use this document" section is kind of useless. The description of hierarchy is meaningless given this doc has only two levels (only one parent "Tutorial"). If the Previous/Next links need explanation, we need to improve the UI design, not try to explain them better. And finally the section "At the bottom of each page there is also a Navbox that will list all of the contents of the guide so any page in the guide will be accessible from any other page in the guide." was never implemented. Let's just delete this section entirely.
Replace this entire main page of the Analytica Tutorial by moving here the "Tutorial Overview" section from Introduction (which also includes links to each chapter).
- Has not been renamed because it introduces Analytica, not just the Tutorial, Fixed otherwise? BB
- Installing Analytica: Check if the instructions are still accurate, e.g. for Free 101. Someone should go through the process (a) with Free 101, (b) with a new activation code and (c) with RLM managed version.
- Using the Rent vs. Buy Model
- Exploring the Rent vs. Buy Model
- Analyzing the Rent vs. Buy Analysis Model
- Creating Models
- Working with Arrays (Tables) shd be linked to and from Dynamic simulation chapter
- Done, BB
- Creating the Party Problem Model
- Creating the Foxes and Hares Model shd be linked to and from Dynamic simulation chapter
- Done, BB
- Sharing Models with Others shd be linked to and from ACP chapter (now section)
- Done, BB
- Example Models and Libraries shd be linked to and from User-defined functions and libraries chapter
- Done, BB
- For each chapter and or section in the Tutorial, add "See Also" links to corresponding chapters or sections of the User Guide that provide more details about each main feature introduced in that section. For example. in Analyzing the Rent vs. Buy Analysis Model add links to Importance analysis and Parametric analysis of model behavior. Also, put reciprocal link from See also in Parametric analysis of model behavior to the Analyzing the Rent vs. Buy Analysis Model in Tutorial. In the latter case, the link text (i.e. what user sees) should say "Tutorial on Parametric Analysis"so the link should actually be Tutorial on Parametric Analysis. Similarly, link from Tutorial to User Guide should be User Guide: Parametric analysis.
- Done, BB
Analytica User Guide
- Add a redirect page to this from User Guide
- Done, BB
Analytica basics
- Rename to "Introduction to the Analytica User Guide"
- Decided not to rename (the page introduces Analytica, not just the user guide), MH/BB
- If you don’t read manuals
- Move this to bottom of the main Analytica User Guide page.
- Decided not to move the page but to add a link to it before the TOC at Analytica User Guide, MH/BB
- Hardware and software requirements
- Installation and licenses
- Editions of Analytica
- Add links from every edition to relevant section in User Guide, Optimizer Guide, including ACP.
- Done?
- Add ACP Premium Plan and update ACP terminology Karen
- Add links from every feature in table to relevant section describing that feature
- Help menu and documentation
- Normally, usually, and defaults
- Typographic conventions in this guide
- We should aim to have these apply to the entire wiki. If they don't, what are the exceptions? Once they do (mostly) we should move this to a higher level, above the User Guide.
- The main exception seems to be that variables are displayed in bold in the User Guide but in
code
in the rest of the wiki; BB
- User guide Examples folder
- What’s new? Releases of Analytica: What’s new? Rename and link directly to New Releases
- Change this redundant title
- Done, renamed to What's new in recent releases of Analytica?, copied over content from New Releases and made the latter to redirect to the former; BB
- To open or exit a model
- Diagram window
- Classes of variables and other objects
- Selecting nodes
- Toolbar
- User input nodes and user output nodes
- Object window
- Attribute panel
- Values in Object Window
- Printing
- Result window
- Table view of a result
- Graph view of a result
- Uncertainty view of a result
- Comparing results
Parametric analysis <contains no sections>
- Create and save a model
- Create and edit nodes
- Draw arrows
- Draw arrows between modules
- Alias nodes
- To edit an attribute
- Change class of an object
- Preferences dialog
Creating Lucid Influence Diagrams
- About influence diagrams
- Guidelines for creating lucid models
- Arranging nodes to make clear diagrams
- Organizing a module hierarchy
- Color in influence diagrams
- Diagram Style dialog
- Node Style dialog
- Taking screenshots of diagrams
Formatting Numbers, Tables, and Graphs rename to "Number and table formats"
Add a new chapter Graphs split out from the above
Creating and Editing Definitions
- Creating or editing a definition
- The Expression popup menu
- Expression Assist
- Object Finder dialog --- to be replaced by "Find Object" in 4.7
- Definition menu
- The domain of possible values
- Check attribute
Creating Interfaces for End Users
- User interfaces
- User Input nodes
- Choice menu user input
- Checkbox user input
- User output nodes
- User inputs and outputs as aliases
- Onchange attribute
- Button creation
- Form modules
- Icon images in a node
- Graphics, frames, and text in a diagram
- Links or URL in model attributes
- Sharing your model
- Analytica Free 101
- Analytica Cloud Player (ACP)
- Promote ACP to be a chapter level
- Done, BB
- Add in other ACP pages as sections. Karen please review other ACP pages (see Category: Analytica Cloud Player), identify any duplication with this page, and propose how to make them sections for the ACP section.
- Promote ACP to be a chapter level
Using Expressions Rename to Expressions
- Done, BB
- In Intro, say "This chapter introduces the Analytica language used in expressions used in Definitions to calculate the value of a variable from other variables. It describes data types, including Numbers, Date and Time Values, Boolean or truth values, and Text values. It introduces basic Operators, conditionals, and Math functions you can use in expressions.
Analytica includes a general computer language (like Visual Basic or C++). See Procedural Programming for more constructs, including Begin-End for Grouping Expressions, Local Variables, For and While Loops, Recursion, [[References and Data Structures] and Handles to Objects.
- Done, BB
- Numbers
- Date and Time Values
- Boolean or truth values
- Text values
- Operators
- IF a THEN b ELSE c
- Function calls and parameters
- Math functions
- Numbers and text
- INF, NAN, and NULL - Exception values
- Warnings
- Datatype functions
Arrays and Indexes
- Intelligent Arrays
- Indexes and arrays: An introduction
- IF a THEN b ELSE c with arrays
- Creating an index
- Functions that create indexes
- To make an edit table
- To edit a table
- Splice a table when computed indexes change
- Subscript and slice of a subarray
- Choice menus and Checkboxes in an edit table
- Shortcuts to navigate and edit a table
More Array Functions rename to "Array functions"
- Done, BB
- Array Function Example Variables
- Functions that create arrays
- Array-reducing functions
- Transforming functions
- Relational tables and multiD arrays
- Interpolation functions
- Fourier Transform
- Sets - collections of unique elements
- Other array functions
- DetermTable: Deterministic tables
- Subtable: Editable part of an array
- MultiTable: Combining editable and computed arrays
- Matrix functions
Other Functions Rename Text, Date, Math, and Financial Functions
- Move this section to after Expressions
- Done, BB
- Text functions
- Date functions
- Advanced math functions
- Complex number functions
- Financial functions
- Financial library functions
Probability, uncertainty, and Monte Carlo simulation
Expressing Uncertainty Includes PDF, CDF with labels for common terms. Perhaps move this into first section.
- Choosing an appropriate distribution
- Defining a variable as a distribution
- Including a distribution in a definition
- Probabilistic calculation
- Add in new page Monte Carlo and probabilistic simulation
- Done, BB
- Uncertainty Setup dialog
- Probability distributions
- Parametric discrete distributions
- Probability density and mass graphs
- The domain attribute and discrete variables
- Custom discrete probabilities
- Parametric continuous distributions
- Custom continuous distributions
- Special probabilistic functions
- Advanced probability functions --- Move here from Other Functions
- Done, BB
- Multivariate distributions
- Importance weights
Statistics, Sensitivity, and Uncertainty Analysis
- Statistical functions
- Weighted statistics and w parameter
- Importance analysis
- Sensitivity analysis functions
- Tornado charts
- X-Y plots
- Scatter plots
- Regression analysis
- Uncertainty in regression results
- Logistic regression functions
- Stochastic Information Packets (SIPs) -- rename "SIPS and SLURPS: Stochastic Information Packets"
- Decided to keep the shorter name, MH/BB
- Time index
- Dynamic function
- Time index details
- Dynamic initial values
- Dynamic using arrays
- Dynamic dependencies
- Dynamic and uncertainty
- Dynamic on non-Time Indexes
- Reverse Dynamic
Importing, Exporting, and OLE Linking Data -- rename to Integration with data and applications
- Done, BB
- Using the Standard Copy and Paste Commands -- rename "Copy and Paste between applications"
- Done, BB
- Using OLE linking -- rename "OLE linking" move this section to after Import and Export
- Done, BB
- Read from and write to Excel spreadsheets -- rename Excel spreadsheets read and write
- Done, BB
- Using the Import and Export Commands -- rename to "Import and Export data" move to just after "Copy and Paste"
- Extract section "Default and XML Model File Formats" to be its own page Model file formats. This section has little to do with Import and Export commands
- Done, BB
- Move to be sections of this chapter the indicated sections from the Enterprise chapter.
- Done, BB
- Show module hierarchy --- rename to "Module hierarchy"
- Done, BB
- Outline window
- Find variables and other objects -- maybe move to an earlier chapter?
- Manage attributes
- Invalid variables
- Filed modules and libraries
- Import a module or library
- Combining models into an integrated model
- Managing windows
- Memory usage and management
Building Functions and Libraries
- Example function
- Call a function
- Define a function
- Attributes of a function
- Parameter qualifiers
- User Libraries
- Procedural Programming Example
- Summary of Programming Constructs
- Begin-End for Grouping Expressions
- Local Variables
- For and While Loops
- Recursion
- Local Indexes
- Ensuring Array Abstraction
- References and Data Structures
- Handles to Objects
- Dialog Functions
- Other Procedural Functions
- Change this chapter to become a Section, in Working with large models. It should just list all Enterprise-level features with a brief description (40 to 150 words each) and links to their full page description elsewhere.
- Moved Analytica Enterprise to Working with Large Models, BB
- Added a short overview but more detailed descriptions would need to be added (BB)
- For each section below moved to another chapter, add to top of each page "This feature is available in Analytica Enterprise and Optimizer."
- Done, BB
- Database access --- Move to Integration with data and applications
- Done, BB
- Database functions --- Move to Integration with data and applications
- Done, BB
- Read and write text files --- Move to Integration with data and applications. Put this before Database access
- Done, BB
- Read data from URL on internet --- Move to Integration with data and applications. Put this before Database access sections
- Done, BB
- Making a browse-only model and hiding definitions -- Move to Working with Large Models.
- Done, BB
- Huge Arrays -- retain this in Analytica Enterprise section, but maybe copy into the page.
- Done, BB (moved content, deleted page, changed pages that link to the Huge Arrays page)
- Performance Profiler library --- Move to Working with Large Models.
- Done, BB
- RunConsoleProcess - call other applications --- Move to Integration with data and applications
- Done, BB
- COM Automation Objects --- Move to Integration with data and applications
- Done, BB
Appendices rename to Reference sections
- Done, BB
- Selecting the Sample Size: What sample size should you use for modeling uncertainties?
- Move this to be a section in Expressing Uncertainty after Uncertainty Setup dialog
- Done, BB
- Analytica Specifications: Requirements and specifications, including range and precision of numbers.
- Identifiers Already Used: A list of all identifiers used for system functions, variables, attributes, and control words.
- Error Message Types: Types of error message
- Include see also links to Error message categories
- Done, BB
- Forward and Backward Compatibility: Compatibility for Analytica releases for running models created with earlier or later releases.
- Bibliography: Books and links for useful background information.
Analytica Optimizer Guide
- Add a redirect page to this from Optimizer and Optimization
- Done, BB
- Redo this page to list sections (with anchor links) under each chapter
- Introduction rename Introducing the Analytica Optimizer
- Done, renamed to Introduction to Optimizer
- Quick Start rename Optimizer Quick Start
- Done, BB
- Optimization Characteristics
- Optimizing with Arrays
- Key Concepts: The Airline NLP Example rename Optimizer key concepts: Airline Example
- Done, BB
- Optimizer Attribute Reference rename Optimizer Attributes
- Done, BB
- Optimizer Function Reference rename Optimizer Functions
- Done, BB
- Control Settings rename Optimizer Control Settings
- Done, renamed to Optimizer control settings, BB