[Gd-chatter] r11198 - trunk/documentation/gwydion/gdcore/project

[agent at gwydiondylan.org]

Author: agent
Date: Wed Feb 21 07:05:23 2007
New Revision: 11198

Added:
   trunk/documentation/gwydion/gdcore/project/Topics.txt   (contents, props changed)
Log:
Bug: 7344
Topics.txt might need to be modified. Adding it to SVN.


Added: trunk/documentation/gwydion/gdcore/project/Topics.txt
==============================================================================
--- (empty file)
+++ trunk/documentation/gwydion/gdcore/project/Topics.txt	Wed Feb 21 07:05:23 2007
@@ -0,0 +1,169 @@
+Format: 1.35
+
+# This is the Natural Docs topics file for this project.  If you change anything
+# here, it will apply to THIS PROJECT ONLY.  If you'd like to change something
+# for all your projects, edit the Topics.txt in Natural Docs' Config directory
+# instead.
+
+
+Ignore Keywords: key, note
+
+
+#-------------------------------------------------------------------------------
+# SYNTAX:
+#
+# Topic Type: [name]
+# Alter Topic Type: [name]
+#    Creates a new topic type or alters one from the main file.  Each type gets
+#    its own index and behavior settings.  Its name can have letters, numbers,
+#    spaces, and these charaters: - / . '
+#
+# Plural: [name]
+#    Sets the plural name of the topic type, if different.
+#
+# Keywords:
+#    [keyword]
+#    [keyword], [plural keyword]
+#    ...
+#    Defines or adds to the list of keywords for the topic type.  They may only
+#    contain letters, numbers, and spaces and are not case sensitive.  Plural
+#    keywords are used for list topics.  You can redefine keywords found in the
+#    main topics file.
+#
+# Index: [yes|no]
+#    Whether the topics get their own index.  Defaults to yes.  Everything is
+#    included in the general index regardless of this setting.
+#
+# Scope: [normal|start|end|always global]
+#    How the topics affects scope.  Defaults to normal.
+#    normal        - Topics stay within the current scope.
+#    start         - Topics start a new scope for all the topics beneath it,
+#                    like class topics.
+#    end           - Topics reset the scope back to global for all the topics
+#                    beneath it.
+#    always global - Topics are defined as global, but do not change the scope
+#                    for any other topics.
+#
+# Class Hierarchy: [yes|no]
+#    Whether the topics are part of the class hierarchy.  Defaults to no.
+#
+# Variable Type: [yes|no]
+#    Whether the topics can be a variable type.  Defaults to no.
+#
+# Page Title If First: [yes|no]
+#    Whether the topic's title becomes the page title if it's the first one in
+#    a file.  Defaults to no.
+#
+# Break Lists: [yes|no]
+#    Whether list topics should be broken into individual topics in the output.
+#    Defaults to no.
+#
+# Can Group With: [type], [type], ...
+#    Defines a list of topic types that this one can possibly be grouped with.
+#    Defaults to none.
+#-------------------------------------------------------------------------------
+
+# The following topics are defined in the main file, if you'd like to alter
+# their behavior or add keywords:
+#
+#    Generic, Class, Interface, Section, File, Group, Function, Variable,
+#    Property, Type, Constant, Enumeration, Event, Delegate, Macro,
+#    Database, Database Table, Database View, Database Index, Database
+#    Cursor, Database Trigger, Cookie, Build Target
+
+# If you add something that you think would be useful to other developers
+# and should be included in Natural Docs by default, please e-mail it to
+# topics [at] naturaldocs [dot] org.
+
+
+Alter Topic Type: Group
+
+   Add Keywords:
+      subsection, subsections
+
+
+Alter Topic Type: Property
+
+   Add Keywords:
+      getter, getters
+      getter method, getter methods
+      setter, setters
+      setter method, setter methods
+
+
+Alter Topic Type: Variable
+
+   Page Title If First: Yes
+   Add Keywords:
+      slot, slots
+
+
+Alter Topic Type: File
+
+   Index: No
+
+
+Alter Topic Type: Function
+
+   Page Title If First: Yes
+
+
+Topic Type: Generic Function
+
+   Plural: Generic Functions
+   Page Title If First: Yes
+
+   Keywords:
+      generic function, generic functions
+      generic, generics
+
+
+Alter Topic Type: Type
+
+   Page Title If First: Yes
+   Add Keywords:
+      singleton, singletons
+      limited type, limited types
+      type union, type unions
+
+
+Topic Type: Dylan Class
+
+   Plural: Dylan Classes
+   Page Title If First: Yes
+
+   Keywords:
+      class, classes
+
+
+Topic Type: Exception
+
+   Plural: Exceptions
+   Page Title If First: Yes
+   Break Lists: Yes
+
+   Keywords:
+      exception, exceptions
+      error, errors
+
+
+Topic Type: Module
+
+   Plural: Modules
+   Page Title If First: Yes
+   Break Lists: Yes
+
+   Keywords:
+      module, modules
+      namespace, namespaces
+
+
+Topic Type: Library
+
+   Plural: Libraries
+   Index: No
+   Page Title If First: Yes
+
+   Keywords:
+      library, libraries
+      package, packages