source: branches/lib/HELP_SOURCE/source/cluster_group.hlp

Last change on this file was 19532, checked in by westram, 4 months ago
  • reintegrates 'help' into 'trunk'
    • tweak arb documentation:
      • automatically link
        • ticket references to arb bug tracker (only affects html version).
        • found URLs.
      • page titles
        • warn about long titles.
        • introduce SUBTITLEs (automatically triggered by multi-line titles in source files).
        • increase allowed length (limited by subwindow width).
      • cleanup header sections in all helpfiles.
      • fix and/or update several help files.
      • document syntax of help sources.
      • build issues:
        • when xml validation fails, next build no longer uses invalid xml ⇒ keeps failing.
        • remove output files on error (including files below ARBHOME/lib).
        • pipe output through logs to ensure proper wrapping in Entering/Leaving lines.
    • moves Tree admin + NDS menu entries to top of menu
  • adds: log:branches/help@18783:19531
File size: 2.6 KB
Line 
1#       main topics:
2UP      arb.hlp
3UP      glossary.hlp
4UP      di_clusters.hlp
5
6#       sub topics:
7#SUB     subtopic.hlp
8
9# format described in ../help.readme
10
11
12TITLE           Cluster groups
13
14OCCURRENCE      ARB_DIST/Detect clusters/Cluster groups
15
16DESCRIPTION     Choose whether you like to create (or delete) groups for all 'listed clusters' or
17                for the currently 'selected cluster' only.
18
19                Specify the wanted identity between cluster and the subtree, where the group will
20                be created. If you just calculated clusters (for the tree currently selected in the
21                ARB_DIST main window) the identity will always be 100%.
22                Specifying a lower identity value, allows to apply groups to a different tree.
23
24                Click on 'create groups' to create groups for affected clusters.
25
26                It might happen, that your tree already contains groups, where this function
27                likes to insert new ones. In this case you can choose to either
28
29                      - abort (the default)
30                      - skip
31                      - overwrite with generated name or
32                      - overwrite and append original group name.
33
34                You can specify a name prefix for the generated group names.
35
36                The rest of the name is generated from the 'Name suffix' specification.
37                This specification may contain normal text and the following codes:
38
39                     %p            position in upgroup (which don't start with cluster prefix)
40                     %P            position in upgroup
41                     %t            position in tree
42                     %d            mean distance of cluster
43                     %D            max allowed distance (as set in input field)
44                     %o            "..%_of" (only occurs when applying to different tree topology)
45                     %e            existing group-name
46                     %%            %
47
48                The single parts of the name get separated by the string specified as 'Separator'.
49
50                Click on 'delete groups' to erase groups existing at cluster subtrees. You can select
51                to remove all groups or only groups matching the name prefix.
52
53                   If you have used 'append original' while creating groups, arb will restore the
54                   original groups name instead of deleting the group.
55
56NOTES           This function always affects the tree currently selected in the ARB_DIST main window.
57
58EXAMPLES        None
59
60WARNINGS        Be careful when using 'overwrite' without appending original names.
61                It will destroy existing groups.
62
63BUGS            No bugs known
Note: See TracBrowser for help on using the repository browser.