Analysis Documentation
Names and rules for Analysis top-level menus
For popups that are opened from menu, the name in title bar of the popup should be:
CATEGORY: ITEM_TEXT
where CATEGORY is the menu name (e.g. Experiment, Molecules, etc.) and ITEM_TEXT is the text of the actual item (e.g. Edit Spectrum) but with parenthetical text removed.
Menus and items
Things marked with * are changed.Project:
- New
- Open
- Close
- Save
- Save As
- Validate
- User Profile
- Backup
- Quit
- Updates
- Open Spectra
- Edit Spectra
- Edit Experiments
- NMR Series
- Experiment Prototypes
- New Window
- Edit Windows
- Axes
- Marks and Rulers
- Print Window
- Selected Peaks
- Peak Lists
- Draw Parameters
- Peak Finding
- Atom Browser
- Molecule Setup
- Add Sequence
- Residue Information
- Isotopomer Schemes
- Assignment Panel
- Copy Assignments
- Quality Reports
- Initialise Roots
- Link Peak Lists
- Link Sequential Spin Systems *
- Link NOEs
- Automated Backbone Sequence
- Resonance Table
- Spin Systems
- Spin System Types
- Reference Chemical Shifts *
- Measurement Lists
- Rates Analysis
- Shift Differences
- Follow Shift Changes
- 3J H-H\alpha Coupling *
- Heteronuclear NOE*
- Make Distance Restraints *
- Restraints and Violations *
- Structure Viewer
- Structure Ensembles*
- DANGLE (Predict Dihedrals) *
- Assignment Graph
- Chemical Shifts *
- Secondary Structure *
- NOE Matrix *
- Ramachandran Plot *
- Organise Macros
- Reload Menu Macros
- Help
- General Options
- Colour Schemes*
- Fonts
- Format Converter
- CLOUDS* (all sub-menus as now) - Capitalise
COMMENTS
- Use plural systematically for menu names that refer to CCPN objects, except for Project. Note tah Assignment and Data Analysis are not CCPN objects. (Rasmus)- How is the XML mapped to 1) the code, 2) the documentation Wiki - are tehre any persisten identifiers? .
More specifically: If things are moved around, what happens to the IDs?
If things are renamed what happens to the name? If either, how do you know which new elements match which old elements or old doc?
Can this be autogenerated from the actual code in any way?
DOCUMENTATION XML SCHEME
<? xml version="1.0" encoding="UTF-8" ?>
<UNIT name='EditExperiment'>
<DOC LANGUAGE='english'>
This popup allows you to mess with experiments.
</DOC>
<ITEM ID='1' NAME='experimentPulldown' WIDGET='PulldownList'>
<DOC LANGUAGE='english'>
The experiment pulldown blah blah blah
</DOC>
</ITEM>
<ITEM ID='3' NAME='tabbedFrame' WIDGET='TabbedFrame'>
<!-- No documentation for this item -->
<ITEM ID='3.1' name='Main', WIDGET='TabbedFrame.frame'>
<DOC LANGUAGE='english'>
This tab contains...
</DOC>
<ITEM ID='3.1.1' NAME='experimentTable' WIDGET='ScrolledMatrix'>
<DOC LANGUAGE='english'>
The main table is...
</DOC>
<ITEM ID='3.1.1.1' name='#' WIDGET='ScrolledMatrix.column'>
<DOC LANGUAGE='english'>
This column contains the serial number for the experiment
</DOC>
</ITEM>
<ITEM ID='3.1.1.2' name='name' WIDGET='ScrolledMatrix.column'>
<DOC LANGUAGE='english'>
The name of the experiment (editable).
</DOC>
</ITEM>
</ITEM>
</ITEM>
<ITEM ID='3.2' name='Experiment Details' WIDGET='TabbedFrame.frame'>
<DOC LANGUAGE='english'>
This tab contains...
</DOC>
</ITEM>
<ITEM ID='3.3' name='Experiment Types' WIDGET='TabbedFrame.frame'>
<DOC LANGUAGE='english'>
This tab contains...
</DOC>
</ITEM>
</ITEM>
</UNIT>