Changeset 35a889 for src/documentation/userinterfaces

Timestamp:

Nov 1, 2011, 8:45:14 PM (13 years ago)

Author:

Frederik Heber <heber@…>

Branches:

Action_Thermostats, Add_AtomRandomPerturbation, Add_FitFragmentPartialChargesAction, Add_RotateAroundBondAction, Add_SelectAtomByNameAction, Added_ParseSaveFragmentResults, AddingActions_SaveParseParticleParameters, Adding_Graph_to_ChangeBondActions, Adding_MD_integration_tests, Adding_ParticleName_to_Atom, Adding_StructOpt_integration_tests, AtomFragments, Automaking_mpqc_open, AutomationFragmentation_failures, Candidate_v1.5.4, Candidate_v1.6.0, Candidate_v1.6.1, ChangeBugEmailaddress, ChangingTestPorts, ChemicalSpaceEvaluator, CombiningParticlePotentialParsing, Combining_Subpackages, Debian_Package_split, Debian_package_split_molecuildergui_only, Disabling_MemDebug, Docu_Python_wait, EmpiricalPotential_contain_HomologyGraph, EmpiricalPotential_contain_HomologyGraph_documentation, Enable_parallel_make_install, Enhance_userguide, Enhanced_StructuralOptimization, Enhanced_StructuralOptimization_continued, Example_ManyWaysToTranslateAtom, Exclude_Hydrogens_annealWithBondGraph, FitPartialCharges_GlobalError, Fix_BoundInBox_CenterInBox_MoleculeActions, Fix_ChargeSampling_PBC, Fix_ChronosMutex, Fix_FitPartialCharges, Fix_FitPotential_needs_atomicnumbers, Fix_ForceAnnealing, Fix_IndependentFragmentGrids, Fix_ParseParticles, Fix_ParseParticles_split_forward_backward_Actions, Fix_PopActions, Fix_QtFragmentList_sorted_selection, Fix_Restrictedkeyset_FragmentMolecule, Fix_StatusMsg, Fix_StepWorldTime_single_argument, Fix_Verbose_Codepatterns, Fix_fitting_potentials, Fixes, ForceAnnealing_goodresults, ForceAnnealing_oldresults, ForceAnnealing_tocheck, ForceAnnealing_with_BondGraph, ForceAnnealing_with_BondGraph_continued, ForceAnnealing_with_BondGraph_continued_betteresults, ForceAnnealing_with_BondGraph_contraction-expansion, FragmentAction_writes_AtomFragments, FragmentMolecule_checks_bonddegrees, GeometryObjects, Gui_Fixes, Gui_displays_atomic_force_velocity, ImplicitCharges, IndependentFragmentGrids, IndependentFragmentGrids_IndividualZeroInstances, IndependentFragmentGrids_IntegrationTest, IndependentFragmentGrids_Sole_NN_Calculation, JobMarket_RobustOnKillsSegFaults, JobMarket_StableWorkerPool, JobMarket_unresolvable_hostname_fix, MoreRobust_FragmentAutomation, ODR_violation_mpqc_open, PartialCharges_OrthogonalSummation, PdbParser_setsAtomName, PythonUI_with_named_parameters, QtGui_reactivate_TimeChanged_changes, Recreated_GuiChecks, Rewrite_FitPartialCharges, RotateToPrincipalAxisSystem_UndoRedo, SaturateAtoms_findBestMatching, SaturateAtoms_singleDegree, StoppableMakroAction, Subpackage_CodePatterns, Subpackage_JobMarket, Subpackage_LinearAlgebra, Subpackage_levmar, Subpackage_mpqc_open, Subpackage_vmg, Switchable_LogView, ThirdParty_MPQC_rebuilt_buildsystem, TrajectoryDependenant_MaxOrder, TremoloParser_IncreasedPrecision, TremoloParser_MultipleTimesteps, TremoloParser_setsAtomName, Ubuntu_1604_changes, stable

Children:

a28cc4

Parents:

bc3411

git-author:

Frederik Heber <heber@…> (11/01/11 19:56:58)

git-committer:

Frederik Heber <heber@…> (11/01/11 20:45:14)

Message:

DOCUFIX: Prefixes all three userinterface labels with userinterfaces-.

Location:

src/documentation/userinterfaces

Files:

• commandline.dox (modified) (1 diff)
• graphical.dox (modified) (3 diffs)
• textmenu.dox (modified) (1 diff)
• userinterfaces.dox (modified) (1 diff)

src/documentation/userinterfaces/commandline.dox

@@ -14 +14 @@
 
 /**
- * \page commandline Command Line Interface
+ * \page userinterfaces-commandline Command Line Interface
  *
  * The command line interface allows for using MoleCuilder within scripts such

src/documentation/userinterfaces/graphical.dox

@@ -14 +14 @@
 
 /**
- * \page graphical Graphical User Interface
+ * \page userinterfaces-graphical Graphical User Interface
  *
  * The GUI is based on Qt4. It used Qt3D for displaying the GlWorldView and
@@ -26 +26 @@
  * - A list of all currently present molecules.
  *
- * \section graphical-query Queries in the graphical interface.
+ * \section userinterfaces-graphical-query Queries in the graphical interface.
  *
  * As all Action always instantiate a Dialog which behaves differently for
@@ -40 +40 @@
  * ValueStorage.
  *
- * \section graphical-world_view How the World view works ...
+ * \section userinterfaces-graphical-world_view How the World view works ...
  *
  * GLWorldView handles the Observer translation to Qt's own mechanism. Also, it

src/documentation/userinterfaces/textmenu.dox

@@ -14 +14 @@
 
 /**
- * \page textmenu Text Menu Interface
+ * \page userinterfaces-textmenu Text Menu Interface
  *
  *  The textmenu mimicks the graphical interface in having the very same menu

src/documentation/userinterfaces/userinterfaces.dox

@@ -17 +17 @@
  *
  *  MoleCuilder has three interfaces at your disposal:
- *  -# \ref textmenu  A simple interactive console-based menu, where awaits your choices and inputs in order to set atoms
+ *  -# \ref userinterfaces-textmenu  A simple interactive console-based menu,
+ *    where awaits your choices and inputs in order to set atoms
  *               as you like
- *  -# \ref commandline Every command can also be chained up as a sequence of actions on the command line to be executed
+ *  -# \ref userinterfaces-commandline Every command can also be chained up as
+ *    a sequence of actions on the command line to be executed
  *               with any user interaction.
- *  -# \ref graphical A graphical user interface that also display the molecular structure being built and lots of other
+ *  -# \ref userinterfaces-graphical A graphical user interface that also
+ *    display the molecular structure being built and lots of other
  *               informations to ease the construction of bigger geometries.
  *