Difference between revisions of "Comments and suggestions for Analytica docs"
m (Added ideas on how reorganize and clean up the Analytica wiki)
Line 1: Line 1:
−
Suggestions and requests for what you'd like to see covered in the Analytica wiki.
+
= Requested content =
 +
 
 +
Suggestions and requests for additional content you'd like to see covered in the Analytica wiki.
  
 
If you can write something yourself, please do so. Put it in the page that seems most appropriate -- or add a new page. If not, add your request here, and hopefully someone else will do so.
 
If you can write something yourself, please do so. Put it in the page that seems most appropriate -- or add a new page. If not, add your request here, and hopefully someone else will do so.
Line 8: Line 10:
  
 
* How do I decide which Edition of Analytica to use?
 
* How do I decide which Edition of Analytica to use?
 +
 +
= General reorganization and clean up =
 +
 +
== Typography and format ==
 +
 +
* Code, usually Analytica expressions, use the <code>format</code> markup.  This looks fine in Firefox and Internet Explorer, but the code shows up in small font on Chrome. See if we can find a way to fix this. One method is simply to use a space at the start of each line, which is the standard way to markup code.
 +
Like this.
 +
It puts the text into an indented box
 +
 +
== Updating ==
 +
 +
* Many features say which release introduced them as in "New in Analytica 4.1". We should delete these,
 +
except perhaps for those introduced in the latest release 4.4.
 +
 +
 +
== Reorganizing ==
 +
 +
There is lots of useful information in Analytica wiki, but it's not always easy to find.
 +
There is considerable scope for reorganizing it to make stuff easier to find. Here are some
 +
ideas for doing that.
 +
 +
[[Creating Arrays (Tables)]]  This contains 8 pages that follow Chapter 5 from the Analytica Tutorial,
 +
a rather old version according the the screenshots (dated Sep 2007).
 +
It's not clear what the value is of having this in the Analytica wiki, since it's more
 +
accessible in the Tutorial.  If we want to retain in wiki, it should be updated,
 +
and given links from each page to the next. Otherwise, let's just delete it.
 +
 +
 +
=== Home page ===
 +
 +
* Reorganize the links into logically related groups with subheadings.
 +
* Rearrange the links into two columns.
 +
* Use a smaller Analytica logo.
 +
 +
=== Index pages ===
 +
 +
There are several pages like the home page [[Analytica User FAQs]] that are simply a list of links.
 +
Preferably
 +
* The links should be simple text, not headings.
 +
* There is no need for a local contents section on these pages, unless they contain 100s of links so that they are not all visible without scrolling. In that case, the contents would be links to subheadings organizing groups of links.
 +
* Unless the name of the link is self-explanatory, there should be a phrase next to each link to explain what kind of material it contains.
  
 
[[ana:test page alpha]]
 
[[ana:test page alpha]]

Revision as of 21:47, 11 November 2012

Requested content

Suggestions and requests for additional content you'd like to see covered in the Analytica wiki.

If you can write something yourself, please do so. Put it in the page that seems most appropriate -- or add a new page. If not, add your request here, and hopefully someone else will do so.

  • Explain better how to use Intelligent Arrays effectively.
  • How do I go about translating an Excel spreadsheet into Analytica?
  • How do I decide which Edition of Analytica to use?

General reorganization and clean up

Typography and format

  • Code, usually Analytica expressions, use the format markup. This looks fine in Firefox and Internet Explorer, but the code shows up in small font on Chrome. See if we can find a way to fix this. One method is simply to use a space at the start of each line, which is the standard way to markup code.
Like this. 
It puts the text into an indented box

Updating

  • Many features say which release introduced them as in "New in Analytica 4.1". We should delete these,

except perhaps for those introduced in the latest release 4.4.


Reorganizing

There is lots of useful information in Analytica wiki, but it's not always easy to find. There is considerable scope for reorganizing it to make stuff easier to find. Here are some ideas for doing that.

Creating Arrays (Tables) This contains 8 pages that follow Chapter 5 from the Analytica Tutorial, a rather old version according the the screenshots (dated Sep 2007). It's not clear what the value is of having this in the Analytica wiki, since it's more accessible in the Tutorial. If we want to retain in wiki, it should be updated, and given links from each page to the next. Otherwise, let's just delete it.


Home page

  • Reorganize the links into logically related groups with subheadings.
  • Rearrange the links into two columns.
  • Use a smaller Analytica logo.

Index pages

There are several pages like the home page Analytica User FAQs that are simply a list of links. Preferably

  • The links should be simple text, not headings.
  • There is no need for a local contents section on these pages, unless they contain 100s of links so that they are not all visible without scrolling. In that case, the contents would be links to subheadings organizing groups of links.
  • Unless the name of the link is self-explanatory, there should be a phrase next to each link to explain what kind of material it contains.

ana:test page alpha

Comments


You are not allowed to post comments.