The Sort Topics Dialog

Help Builder supports sorting topics in each subtree based through a SortOrder value. A higher number means higher in the sort order or at the top of the tree. All topics are by default entered as SortOrder 0, which means at the bottom of the sort order. The default sort order when no SortOrder value is set is:

  • Topic Type (Method, Property, Topic etc in alphabetic Order)
  • Topic Title

All topics with the same SortOrder value are sorted by Topic Type, then by alphabetic topic title. This groups together all methods and properties and then secondary sorts them by topic.

There are two ways to set the SortOrder value, which overrides the default sort order by assigning a value to the SortOrder field. Higher numbers mean higher in the sort order:

  • Set it manually on the Related Topics tab The Related Topics tab includes a SortOrder value. By default this value is 0 - higher relative numbers mean higher in the list. Note SortOrder changes are not immediately displayed in the list of topics. To see the updated sort order click on the Refresh button on the toolbar.

  • Use the Sort Topics form
    The Sort Topics form is a visual display of a subtree that allows to select a topic and move it up and down in the sort order.

    The sorter works by assigning specific SortOrder values to all existing topics in increments of 10 (this so you can insert topics at a later time). Once you use the sorter all topics in a subtree have sort order values, so adding any new topics will cause them to be automatically dropped to the bottom of the list. You can revert to the default sort order using topic type and topic name by clicking on the Default Order button.

    Unless you click on the Update button none of the changes made in this form will take! When you're sure the topic order is appropriate click Update and the new topic SortOrder values are updated on each topic and the tree is updated to display the new sort order.

See also

Adding a new topic

© West Wind Techologies, 2018 • Updated: 12/14/15
Comment or report problem with topic