doc/naturaldocs/conf/lenses/Topics.txt

   1 Format: 1.52
   2
   3 # This is the Natural Docs topics file for this project.  If you change anything
   4 # here, it will apply to THIS PROJECT ONLY.  If you'd like to change something
   5 # for all your projects, edit the Topics.txt in Natural Docs' Config directory
   6 # instead.
   7
   8
   9 Ignore Keywords:
  10    class
  11
  12
  13 #-------------------------------------------------------------------------------
  14 # SYNTAX:
  15 #
  16 # Topic Type: [name]
  17 # Alter Topic Type: [name]
  18 #    Creates a new topic type or alters one from the main file.  Each type gets
  19 #    its own index and behavior settings.  Its name can have letters, numbers,
  20 #    spaces, and these charaters: - / . '
  21 #
  22 # Plural: [name]
  23 #    Sets the plural name of the topic type, if different.
  24 #
  25 # Keywords:
  26 #    [keyword]
  27 #    [keyword], [plural keyword]
  28 #    ...
  29 #    Defines or adds to the list of keywords for the topic type.  They may only
  30 #    contain letters, numbers, and spaces and are not case sensitive.  Plural
  31 #    keywords are used for list topics.  You can redefine keywords found in the
  32 #    main topics file.
  33 #
  34 # Index: [yes|no]
  35 #    Whether the topics get their own index.  Defaults to yes.  Everything is
  36 #    included in the general index regardless of this setting.
  37 #
  38 # Scope: [normal|start|end|always global]
  39 #    How the topics affects scope.  Defaults to normal.
  40 #    normal        - Topics stay within the current scope.
  41 #    start         - Topics start a new scope for all the topics beneath it,
  42 #                    like class topics.
  43 #    end           - Topics reset the scope back to global for all the topics
  44 #                    beneath it.
  45 #    always global - Topics are defined as global, but do not change the scope
  46 #                    for any other topics.
  47 #
  48 # Class Hierarchy: [yes|no]
  49 #    Whether the topics are part of the class hierarchy.  Defaults to no.
  50 #
  51 # Page Title If First: [yes|no]
  52 #    Whether the topic's title becomes the page title if it's the first one in
  53 #    a file.  Defaults to no.
  54 #
  55 # Break Lists: [yes|no]
  56 #    Whether list topics should be broken into individual topics in the output.
  57 #    Defaults to no.
  58 #
  59 # Can Group With: [type], [type], ...
  60 #    Defines a list of topic types that this one can possibly be grouped with.
  61 #    Defaults to none.
  62 #-------------------------------------------------------------------------------
  63
  64 # The following topics are defined in the main file, if you'd like to alter
  65 # their behavior or add keywords:
  66 #
  67 #    Generic, Class, Interface, Section, File, Group, Function, Variable,
  68 #    Property, Type, Constant, Enumeration, Event, Delegate, Macro,
  69 #    Database, Database Table, Database View, Database Index, Database
  70 #    Cursor, Database Trigger, Cookie, Build Target
  71
  72 # If you add something that you think would be useful to other developers
  73 # and should be included in Natural Docs by default, please e-mail it to
  74 # topics [at] naturaldocs [dot] org.
  75
  76
  77 Topic Type: Augeas Lens
  78
  79    Plural: Augeas Lenses
  80    Keywords:
  81       view, views
  82
  83
  84 Topic Type: Augeas Variable
  85
  86    Plural: Augeas Variables
  87    Keywords:
  88       variable, variables
  89
  90
  91 Topic Type: Augeas Test
  92
  93    Plural: Augeas Tests
  94    Keywords:
  95       test, tests
  96
  97
  98 Topic Type: Augeas Module
  99
 100    Plural: Augeas Modules
 101    Scope: Start
 102    Page Title If First: Yes
 103
 104    Keywords:
 105       module, modules