From 6f7dddcd6f25a8c1e1b38ae8ba7e166e0227ed0d Mon Sep 17 00:00:00 2001 From: wlang42 Date: Thu, 27 Oct 2022 00:03:39 +0200 Subject: [PATCH 01/25] add .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b25c15b --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +*~ From 52a16d05e117e146931b3f4c9db672821d6dc0aa Mon Sep 17 00:00:00 2001 From: wlang42 Date: Thu, 27 Oct 2022 00:07:14 +0200 Subject: [PATCH 02/25] remove trailing whitespaces --- .doxygen.conf | 1028 ++++++++++----------- Admin.py | 16 +- Archive.py | 2 +- CMF.py | 16 +- CONTRIBUTORS.txt | 2 +- Catalog.py | 8 +- DEVELOPERS.txt | 22 +- Defaults.py | 18 +- Diff.py | 6 +- Editing.py | 42 +- Extensions/Install.py | 8 +- Extensions/Install_tests.py | 2 +- History.py | 4 +- Mail.py | 46 +- Makefile | 4 +- Outline.py | 14 +- OutlineSupport.py | 56 +- README.txt | 6 +- Regexps.py | 6 +- TextFormatter.py | 2 +- Utils.py | 28 +- Views.py | 16 +- ZWikiPage.py | 98 +- __init__.py | 18 +- bin/zwikiexport.py | 4 +- bin/zwikiimport.py | 6 +- content/basic/FrontPage.stx | 10 +- content/basic/WikiWikiWeb.stx | 2 +- content/basic/ZWiki.stx | 8 +- content/basic/sitemap.xml.dtml | 44 +- content/basic/standard_error_message.dtml | 6 +- i18n/__init__.py | 2 +- plugins/pagetypes/common.py | 22 +- plugins/pagetypes/html.py | 6 +- plugins/pagetypes/rst.py | 8 +- plugins/pagetypes/rst_tests.py | 2 +- plugins/pagetypes/stx.py | 14 +- plugins/pagetypes/stx_tests.py | 2 +- plugins/rating/rating.py | 12 +- plugins/rating/ratingform.pt | 34 +- plugins/rss.py | 4 +- plugins/tracker/FilterIssues.dtml | 40 +- plugins/tracker/IssueBrowser.dtml | 18 +- plugins/tracker/IssueTracker.dtml | 4 +- plugins/tracker/issuepropertiesform.dtml | 6 +- plugins/tracker/tracker.py | 28 +- plugins/tracker/tracker_tests.py | 6 +- scripts/pagesByType.dtml | 4 +- scripts/print.dtml | 12 +- scripts/propreplace.py | 2 +- skins/zwiki/HelpPage.stx | 6 +- skins/zwiki/RecentChanges.dtml | 6 +- skins/zwiki/SearchWiki.dtml | 20 +- skins/zwiki/UserOptions.dtml | 26 +- skins/zwiki/accesskeys.pt | 2 +- skins/zwiki/addwikiform.dtml | 22 +- skins/zwiki/addwikipageform.dtml | 2 +- skins/zwiki/backlinks.pt | 20 +- skins/zwiki/commentform.pt | 20 +- skins/zwiki/denied.pt | 2 +- skins/zwiki/head.pt | 14 +- skins/zwiki/helppage.pt | 2 +- skins/zwiki/hierarchylinks.pt | 4 +- skins/zwiki/maintemplate.pt | 10 +- skins/zwiki/pageheader.pt | 4 +- skins/zwiki/pagemanagementform.pt | 34 +- skins/zwiki/sitefooter.pt | 6 +- skins/zwiki/siteheader.pt | 6 +- skins/zwiki/stylesheet.css | 90 +- skins/zwiki/subscribeform.pt | 58 +- skins/zwiki/subtopics_board.dtml | 4 +- skins/zwiki/subtopics_outline.dtml | 2 +- tests/Catalog_tests.py | 8 +- tests/Editing_tests.py | 34 +- tests/History_tests.py | 10 +- tests/I18n_tests.py | 6 +- tests/Mail_tests.py | 28 +- tests/OutlineSupport_tests.py | 4 +- tests/Outline_tests.py | 4 +- tests/Utils_tests.py | 2 +- tests/Views_tests.py | 4 +- tests/ZWikiPage_tests.py | 8 +- tests/functional.txt | 2 +- tests/functional_tests.py | 2 +- tests/init_tests.py | 2 +- tests/testsupport.py | 8 +- 86 files changed, 1128 insertions(+), 1128 deletions(-) diff --git a/.doxygen.conf b/.doxygen.conf index 1af0005..92d6b0f 100644 --- a/.doxygen.conf +++ b/.doxygen.conf @@ -14,207 +14,207 @@ # Project related configuration options #--------------------------------------------------------------------------- -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = Zwiki -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or # if some version control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = doc/doxygen -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, +# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, +# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, +# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, # Swedish, and Ukrainian. OUTPUT_LANGUAGE = English -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = NO -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" -ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the # path to strip. -STRIP_FROM_PATH = +STRIP_FROM_PATH = -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an # explicit @brief command for a brief description. JAVADOC_AUTOBRIEF = NO -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO -# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member +# If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. -ALIASES = +ALIASES = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = YES -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to -# include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also make the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want to +# include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES @@ -223,326 +223,326 @@ SUBGROUPING = YES # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file +# If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = YES -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the +# Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional +# The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. SHOW_DIRECTORIES = NO -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from the +# version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. -FILE_VERSION_FILTER = +FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated +# The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written # to stderr. -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = +INPUT = -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py -FILE_PATTERNS = +FILE_PATTERNS = -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = .NOTES _darcs misc plugins/mathaction/misc skins/nautica skins/tichu wikis/nautica wikis/tichu -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = */misc/* */nautica/* */tichu/* *maximaWrapper* *_tests.py -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see # the \include command). -EXAMPLE_PATH = +EXAMPLE_PATH = -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left # blank all files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see # the \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be # ignored. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO @@ -551,32 +551,32 @@ FILTER_SOURCE_FILES = NO # configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body +# Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = YES @@ -588,16 +588,16 @@ REFERENCES_RELATION = YES REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES @@ -606,133 +606,133 @@ VERBATIM_HEADERS = YES # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 2 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a # standard header. -HTML_HEADER = +HTML_HEADER = -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! -HTML_STYLESHEET = +HTML_STYLESHEET = -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. HTML_ALIGN_MEMBERS = YES -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be # written to the html output directory. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members +# The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = YES -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO -# This tag can be used to set the number of enum values (range [1..20]) +# This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. GENERATE_TREEVIEW = YES -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 @@ -741,74 +741,74 @@ TREEVIEW_WIDTH = 250 # configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = YES -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. -EXTRA_PACKAGES = +EXTRA_PACKAGES = -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! -LATEX_HEADER = +LATEX_HEADER = -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = NO -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = NO -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO @@ -817,68 +817,68 @@ LATEX_HIDE_INDICES = NO # configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. -RTF_STYLESHEET_FILE = +RTF_STYLESHEET_FILE = -# Set optional variables used in the generation of an rtf document. +# Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. -RTF_EXTENSIONS_FILE = +RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man -# The MAN_EXTENSION tag determines the extension that is added to +# The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO @@ -887,33 +887,33 @@ MAN_LINKS = NO # configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_SCHEMA = +XML_SCHEMA = -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the # syntax of the XML files. -XML_DTD = +XML_DTD = -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES @@ -922,10 +922,10 @@ XML_PROGRAMLISTING = YES # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO @@ -934,319 +934,319 @@ GENERATE_AUTOGEN_DEF = NO # configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. -PERLMOD_MAKEVAR_PREFIX = +PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- -# Configuration options related to the preprocessor +# Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by # the preprocessor. -INCLUDE_PATH = +INCLUDE_PATH = -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. -INCLUDE_FILE_PATTERNS = +INCLUDE_FILE_PATTERNS = -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator # instead of the = operator. -PREDEFINED = +PREDEFINED = -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. -EXPAND_AS_DEFINED = +EXPAND_AS_DEFINED = -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- -# Configuration::additions related to external references +# Configuration::additions related to external references #--------------------------------------------------------------------------- -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen +# If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +TAGFILES = -# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = +GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES -# The PERL_PATH should be the absolute path and name of the perl script +# The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- -# Configuration options related to the dot tool +# Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = NO -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO -# If set to YES, the inheritance and collaboration graphs will show the +# If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected # functions only using the \callgraph command. CALL_GRAPH = NO -# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a caller dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable caller graphs for selected +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a caller dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable caller graphs for selected # functions only using the \callergraph command. CALLER_GRAPH = NO -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png -# The tag DOT_PATH can be used to specify the path where the dot tool can be +# The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. -DOT_PATH = +DOT_PATH = -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the # \dotfile command). -DOTFILE_DIRS = +DOTFILE_DIRS = -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_WIDTH = 1000 -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very # large images. MAX_DOT_GRAPH_HEIGHT = 1000 -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that a graph may be further truncated if the graph's +# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH +# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), # the graph is not depth-constrained. MAX_DOT_GRAPH_DEPTH = 0 -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, which results in a white background. +# Warning: Depending on the platform used, enabling this option may lead to +# badly anti-aliased labels on the edges of a graph (i.e. they become hard to # read). DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- -# Configuration::additions related to the search engine +# Configuration::additions related to the search engine #--------------------------------------------------------------------------- -# The SEARCHENGINE tag specifies whether or not a search engine should be +# The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO diff --git a/Admin.py b/Admin.py index 877e421..fa6a407 100644 --- a/Admin.py +++ b/Admin.py @@ -43,7 +43,7 @@ def upgradeAll(self,render=1,batch=0,REQUEST=None): # -> none Also installs a wiki catalog if not present, re-indexes each page, validates page parents, and rebuilds the wiki outline cache. Also installs the index_html and standard_error_message - dtml methods. XXX split ? + dtml methods. XXX split ? You can set render=0 to skip the page pre-rendering part, completing much faster on large wikis. @@ -59,7 +59,7 @@ def upgradeAll(self,render=1,batch=0,REQUEST=None): # -> none raise Unauthorized, ( _('You are not authorized to upgrade all pages.') + \ _('(folder -> Manage properties)')) - + batch = int(batch) if render: BLATHER('upgrading/reindexing/pre-rendering all pages:') else: BLATHER('upgrading/reindexing all pages:') @@ -203,7 +203,7 @@ def upgrade(self,REQUEST=None): self.last_edit_time = self.last_edit_time.ISO8601() changed = 1 elif len(self.last_edit_time) != 25: - try: + try: if len(self.last_edit_time) == 19: # older "ISO()" format # we're using the behaviour that was standard in # Zope <= 2.9, where a timestamp without timezone @@ -228,7 +228,7 @@ def upgrade(self,REQUEST=None): self.creation_time = self.creation_time.ISO8601() changed = 1 elif len(self.creation_time) != 25: - try: + try: if len(self.creation_time) == 19: # older "ISO()" format self.creation_time = \ DateTime(self.creation_time+' GMT+0').ISO8601() @@ -246,10 +246,10 @@ def upgrade(self,REQUEST=None): '_links', '_prelinked', ): - if safe_hasattr(self.aq_base,a): + if safe_hasattr(self.aq_base,a): delattr(self,a) self.clearCache() - changed = 1 + changed = 1 # update _properties # keep in sync with _properties above. Better if we used that as @@ -299,7 +299,7 @@ def upgrade(self,REQUEST=None): BLATHER('upgraded '+self.id()) self.upgradeComments(REQUEST) - + # PageMailSupport does a bit more (merge here ?) self._upgradeSubscribers() @@ -475,7 +475,7 @@ class Extra: BLATHER('indexing complete, %d pages processed' % n) if REQUEST: REQUEST.RESPONSE.redirect(self.pageUrl()) - + def ensureCatalog(self): """ Ensure this wiki has a zcatalog, for fast standardized searching. diff --git a/Archive.py b/Archive.py index d638e79..92cc19d 100644 --- a/Archive.py +++ b/Archive.py @@ -42,7 +42,7 @@ def archiveFolder(self): if f.isPrincipiaFolderish: return f return None - + security.declareProtected(AccessControl.Permissions.delete_objects, 'archive') def archive(self, REQUEST=None, pagename=None): """Move this page, and all offspring solely parented under this diff --git a/CMF.py b/CMF.py index 029917b..7628640 100644 --- a/CMF.py +++ b/CMF.py @@ -20,7 +20,7 @@ HAS_PLONE = False # XXX also need to skip when running unit tests ? -if not HAS_CMF: +if not HAS_CMF: class PageCMFSupport: __implements__ = () def supportsCMF(self): return 0 @@ -45,7 +45,7 @@ class WikiFolder(SkinnedFolder): def allowedContentTypes( self ): return [] InitializeClass(WikiFolder) - + class ZwikiDublinCoreImpl(DefaultDublinCoreImpl): """ Zwiki's implementation of Dublin Core. @@ -53,7 +53,7 @@ class ZwikiDublinCoreImpl(DefaultDublinCoreImpl): We use our own similar attributes.. XXX maybe we can always use dublin core and simplify. """ - __implements__ = DefaultDublinCoreImpl.__implements__ + __implements__ = DefaultDublinCoreImpl.__implements__ security = ClassSecurityInfo() security.declarePrivate('setModificationDate') @@ -69,9 +69,9 @@ def modified(self): security.declarePublic('Creator') def Creator(self): - if self.creators and len(self.creators) > 0: + if self.creators and len(self.creators) > 0: return self.creators[0] # CMF creators property - else: + else: return self.creator # Zwiki creator property security.declarePublic('Description') @@ -92,7 +92,7 @@ def getPageTitle(self, here=None, template=None, portal_title=None): XXX file a bug """ return self.toencoded(self.pageName()) - + InitializeClass(ZwikiDublinCoreImpl) @@ -102,7 +102,7 @@ class PageCMFSupport(PortalContent, ZwikiDublinCoreImpl): """ __implements__ = ZwikiDublinCoreImpl.__implements__ + \ PortalContent.__implements__ - + portal_type = PAGE_PORTALTYPE # provide this so DublinCore.Format works with old instances format = 'text/html' @@ -183,6 +183,6 @@ def isDefaultPageInFolder(self): """ return self == self.defaultPage() - + InitializeClass(PageCMFSupport) diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index a2c6847..d9a6bff 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -107,7 +107,7 @@ Folks who have contributed in ways other than committing code: - Justin Clift - docs - Paolo Pumilia - italian translation of ZwikiWithFrames - Phil Armstrong - LinkColourHack -- Pieter B - often submits bugs in the [ZwikiTracker]s and works on ZwikiMail and the ZwikiFrontend +- Pieter B - often submits bugs in the [ZwikiTracker]s and works on ZwikiMail and the ZwikiFrontend - Rik Hoekstra - wiki_page_url/virtual hosting suggestions - Ron Dagostino - RecentChangesBySubjectFeature, DeletePageFeature etc - tav - PlexNews (early zwiki/ptk combo) diff --git a/Catalog.py b/Catalog.py index 4f17db0..aebaa6c 100644 --- a/Catalog.py +++ b/Catalog.py @@ -13,7 +13,7 @@ class PageCatalogSupport: Holds most of ZWikiPage's catalog awareness code. Similar to Zope's or CMF's catalog awareness with a little extra behaviour. - Confusing code duplication between zwiki/plone/cmf/zope here. + Confusing code duplication between zwiki/plone/cmf/zope here. """ security = ClassSecurityInfo() @@ -58,7 +58,7 @@ def catalogId(self): """ Give the id of the catalog used by this page, or "NONE". - Should be useful for troubleshooting. + Should be useful for troubleshooting. """ if self.hasCatalog(): return self.catalog().getId() else: return 'NONE' @@ -134,8 +134,8 @@ def SearchableText(self): """ return '%s\n%s' % ( self.toencoded(self.pageName()), self.toencoded(self.text())) - - + + index = index_object # convenience alias indexObject = reindex_object # plone compatibility diff --git a/DEVELOPERS.txt b/DEVELOPERS.txt index 365aee1..b7de89e 100644 --- a/DEVELOPERS.txt +++ b/DEVELOPERS.txt @@ -10,7 +10,7 @@ Zwiki repository policies Here are some guidelines for committers to the main Zwiki repository. - http://zwiki.org/repos/ZWiki is the official Zwiki "trunk" repo, - used for product releases and for running zwiki.org. + used for product releases and for running zwiki.org. A darcsweb interface is available at http://joyful.com/darcsweb/darcsweb.cgi?r=ZWiki;a=summary . @@ -116,7 +116,7 @@ Wiki docs: - can organize a large number of documents in a hierarchy current uses: - + - zwiki.org, including - NextReleaseNewsDraft - unused - GeneralDiscussion @@ -155,7 +155,7 @@ We have the following kinds of in-code documentation: - a section heading within a file, class or method. - - a short explanatory comment appended to a line of code. + - a short explanatory comment appended to a line of code. - longer explanatory comments when necessary. @@ -209,7 +209,7 @@ output types and whether side effects are expected. Function/method contracts ------------------------- -We are considering ways to document function and method "contracts". +We are considering ways to document function and method "contracts". `Here's `_ an example. We are most interested in @@ -224,7 +224,7 @@ an example. We are most interested in Understanding statefulness in particular should help us to identify and gather together the most stateful code, reduce state dependencies, and increase the proportion of pure and semi-pure functional code, which -will greatly aid testing, debugging and reliability. +will greatly aid testing, debugging and reliability. Here is a possible convention for now: when you touch a method or function, review the docstring and code and try add a comment describing @@ -241,7 +241,7 @@ some examples:: def handleSubtopicsProperty(self,subtopics,REQUEST=None): # -> none ; modifies: self - def revisionNumberBefore(self, username): # -> revision number | none + def revisionNumberBefore(self, username): # -> revision number | none # depends on: self, revisions def expungeEditsEverywhereBy(self, username, REQUEST=None, batch=0): # -> none @@ -251,7 +251,7 @@ some examples:: # depends on: wiki # modifies: wiki (folder, pages, dtml methods, catalog, outline, revisions..) -A few more notes: +A few more notes: These don't have to be perfectly correct; even a rough guess could be useful. Do review the contract for correctness every time you change some @@ -281,7 +281,7 @@ valuable to see more lines on the screen than to see the full contents of every line. Keeping lines within 80 characters can obscure the shape of code constructs, especially with functional coding style, and also means we are less likely to see the whole method at once. Long lines, even over -80 characters, may sometimes be preferable. +80 characters, may sometimes be preferable. This assumes you have your editor truncate long lines, not wrap them. I do this, and maximize the window when I need more visibility on the line @@ -291,18 +291,18 @@ ends. Message passing style, functional programming style, etc. --------------------------------------------------------- -The Zwiki codebase is influenced by Smalltalk. Eg: +The Zwiki codebase is influenced by Smalltalk. Eg: - we encapsulate state and behaviour as objects when that makes sense - we break up code into many small methods with intention-revealing names to form an expressive domain-specific language. -- "tell, don't ask", ie just send messages, ignore what's returned. +- "tell, don't ask", ie just send messages, ignore what's returned. We haven't used this and I don't know how it applies to us; it's something to think about. -Recent code is also influenced by functional programming. Eg: +Recent code is also influenced by functional programming. Eg: - we minimise the use of variables and the use of procedural/sequential code (do this, then that, then the other). Instead, we compose functions diff --git a/Defaults.py b/Defaults.py index c89f223..fba9da8 100644 --- a/Defaults.py +++ b/Defaults.py @@ -4,7 +4,7 @@ PAGE_METATYPE = 'ZWiki Page' # meta_type of ZWikiPage objects PAGE_PORTALTYPE = 'Wiki Page' # content type used in CMF/Plone -WIKI_ADD_MENU_NAME = 'ZWiki' # items in ZMI add menu.. +WIKI_ADD_MENU_NAME = 'ZWiki' # items in ZMI add menu.. PAGE_ADD_MENU_NAME = 'ZWiki Page' # (this one must match PAGE_METATYPE) AUTO_UPGRADE = 1 # upgrade old pages when viewed @@ -16,7 +16,7 @@ LINK_TO_ALL_OBJECTS = 0 # link to non-wiki page objects ? unimplemented LARGE_FILE_SIZE = 1024*1024 # images larger than this will not be inlined LEAVE_PLACEHOLDER = 0 # leave a placeholder page when renaming ? -WIKINAME_LINKS = 1 # enable/disable various wiki link syntaxes +WIKINAME_LINKS = 1 # enable/disable various wiki link syntaxes ISSUE_LINKS = 1 # by default BRACKET_LINKS = 1 DOUBLE_BRACKET_LINKS = 1 @@ -24,13 +24,13 @@ BORING_PAGES = ['TestPage','SandBox'] # pages we don't want to see/hear much IDS_TO_AVOID = ['RESPONSE','REQUEST','Epoz','epoz','URL','outline','recycle_bin'] CONDITIONAL_HTTP_GET = 0 # handle If-modified-since headers with 304 responses -CONDITIONAL_HTTP_GET_IGNORE = [ 'allow_dtml' ] - # ignore pages with these properties set to +CONDITIONAL_HTTP_GET_IGNORE = [ 'allow_dtml' ] + # ignore pages with these properties set to # non-False values # Standard metadata fields which we add to the wiki (or plone) catalog # and expect in page brain objects. Plugins can add more of these. -# +# # shouldn't these use the latest accessors, instead of direct field # access, eg to ensure proper unicode encoding ? # there will probably be new and exciting breakage, since our metadata @@ -40,20 +40,20 @@ # last_editor, last_log, parents.. possibly even subscriber_list # they possibly should be: creationTime, Creator (or a new getCreator, # since Creator is for plone and might not want to be unicode), -# lastEditTime, lastEditor, lastLog, getParents, subscriberList +# lastEditTime, lastEditor, lastLog, getParents, subscriberList # seems like a hassle.. would it be bad to add all of them, old and # new ? - metadata can eat a lot of kb # PAGE_METADATA = [ 'Title', 'creation_time', - 'creator', + 'creator', 'id', 'lastEditTime', 'last_edit_time', - 'lastEditor', + 'lastEditor', 'last_log', - 'page_type', + 'page_type', 'parents', 'size', 'subscriber_list', diff --git a/Diff.py b/Diff.py index 9fa4b30..680e916 100644 --- a/Diff.py +++ b/Diff.py @@ -28,7 +28,7 @@ class PageDiffSupport: def diff(self, rev=None, REQUEST=None): """ Show what changed in the latest or specified revision of this page. - + Uses the diffform template. """ if rev: brev = int(rev) @@ -124,7 +124,7 @@ def textdiff(a, b, verbose=1): addm(abbreviate(b[blo:bhi],'',MAX_NEW_LINES_DISPLAY)) add('') else: # tag == 'equal' - pass + pass return '\n' + join(r,'\n') def htmldiff(a,b): @@ -149,7 +149,7 @@ def addnobr(s): r[-1] += s add('changed:') addnobr('') # remember to html-quote the diff segments - addm(prefix(map(html_quote, a[alo:ahi]),'-')) + addm(prefix(map(html_quote, a[alo:ahi]),'-')) addnobr('') addnobr('') addm(map(html_quote, b[blo:bhi])) diff --git a/Editing.py b/Editing.py index 1f8f7e4..9723df6 100644 --- a/Editing.py +++ b/Editing.py @@ -59,7 +59,7 @@ def create(self,page=None,text='',type=None,title='',REQUEST=None,log='', understand it: XXX cleanup - page: the "original" name of the page we are to create. - - pagename: an alternate spelling of the above, to ease page + - pagename: an alternate spelling of the above, to ease page management form implementation. Pass one or the other. - title: optional "new" name to rename to after creation. This allows us to handle the zwiki and CMF/plone @@ -116,7 +116,7 @@ def create(self,page=None,text='',type=None,title='',REQUEST=None,log='', # now really update the wiki outline # XXX should reuse reparent code to do parents validation etc. p.parents = (parents==None) and [self.pageName()] or parents - self.wikiOutline().add(p.pageName(), p.parents) + self.wikiOutline().add(p.pageName(), p.parents) p.setPageType(type or self.defaultPageType()) p.setText(text,REQUEST) p.handleFileUpload(REQUEST) @@ -145,11 +145,11 @@ def create(self,page=None,text='',type=None,title='',REQUEST=None,log='', return name security.declarePublic('edit') # check permissions at runtime - def edit(self, page=None, text=None, type=None, title='', - timeStamp=None, REQUEST=None, + def edit(self, page=None, text=None, type=None, title='', + timeStamp=None, REQUEST=None, subjectSuffix='', log='', check_conflict=1, # temp (?) leaveplaceholder=LEAVE_PLACEHOLDER, updatebacklinks=1, - subtopics=None): + subtopics=None): """General-purpose method for editing & creating zwiki pages. This method does a lot; combining all this stuff in one powerful @@ -179,11 +179,11 @@ def edit(self, page=None, text=None, type=None, title='', # what are we doing ? if page: page = unquote(page) if page is None: # changing this page - p = self + p = self elif self.pageWithNameOrId(page): # changing another page - p = self.pageWithNameOrId(page) + p = self.pageWithNameOrId(page) else: # creating a new page - return self.create(page, + return self.create(page, text or '', type, title, @@ -524,7 +524,7 @@ def clean(s): return re.sub(r'[\r\n]','',s) newname = clean(self.tounicode(pagename)) newid = self.canonicalIdFrom(newname) namechanged, idchanged = newname != oldname, newid != oldid - if not newname or not (namechanged or idchanged): return + if not newname or not (namechanged or idchanged): return # sequence is important here BLATHER('renaming %s (%s) to %s (%s)...' % ( self.toencoded(oldname),oldid,self.toencoded(newname),newid)) @@ -536,7 +536,7 @@ def clean(s): return re.sub(r'[\r\n]','',s) if (idchanged or namechanged) and updatebacklinks: self._replaceLinksEverywhere(oldname,newname,REQUEST) self.index_object() # update catalog XXX manage_renameObject may also, if idchanged - if idchanged and leaveplaceholder: + if idchanged and leaveplaceholder: try: self._makePlaceholder(oldid,newname) except BadRequestException: # special case for CMF/Plone: we'll end up here when first @@ -549,7 +549,7 @@ def clean(s): return re.sub(r'[\r\n]','',s) BLATHER('rename complete') if REQUEST: REQUEST.RESPONSE.redirect(self.pageUrl()) - def _makePlaceholder(self,oldid,newname): + def _makePlaceholder(self,oldid,newname): self.create( oldid, _("This page was renamed to [%s].\n") % (newname), @@ -592,7 +592,7 @@ def reparentChildren(self,newparent): child.removeParent(self.pageName()) child.addParent(newparent) child.index_object() # XXX need only reindex parents - + def _replaceLinksEverywhere(self,oldlink,newlink,REQUEST=None): """Replace one link with another throughout the wiki. @@ -713,14 +713,14 @@ def appendQuietly(linktxt,log,REQUEST): self.setLastLog(log) self.index_object() appendQuietly(fileOrImageLink(),log,REQUEST) - + def _setOwnership(self, REQUEST=None): """Set appropriate ownership for a new page. To help control executable content, we make sure the new page acquires it's owner from the parent folder. """ self._deleteOwnershipAfterAdd() - + # for IssueNo0157 _old_read = DTMLDocument.read security.declareProtected(Permissions.View, 'read') @@ -732,7 +732,7 @@ def read(self): def text(self, REQUEST=None, RESPONSE=None): """ Return this page's source text, with text/plain content type. - + (a permission-free version of document_src) # XXX security ? """ @@ -771,7 +771,7 @@ def checkForSpam(self, t=''): def forbid(reason): BLATHER('%s blocked edit from %s (%s), %s:\n%s' % (path, ip, username, reason, t)) raise Forbidden, "There was a problem, please contact the site admin." - + # content matches a banned pattern ? for pat in self.getSpamPatterns(): if re.search(pat,t): forbid("spam pattern found") @@ -786,7 +786,7 @@ def getSpamPatterns(self): else: BLATHER('checking zwiki.org spam blacklist') req = urllib2.Request( - ZWIKI_SPAMPATTERNS_URL, + ZWIKI_SPAMPATTERNS_URL, None, {'User-Agent':'Zwiki %s' % self.zwiki_version()} ) @@ -872,7 +872,7 @@ def checkEditConflict(self, timeStamp, REQUEST): Warn if this edit would be in conflict with another. Edit conflict checking based on timestamps - - + things to consider: what if - we are behind a proxy so all ip's are the same ? - several people use the same cookie-based username ? @@ -912,7 +912,7 @@ def checkEditConflict(self, timeStamp, REQUEST): security.declareProtected(Permissions.View, 'timeStamp') def timeStamp(self): return str(self._p_mtime) - + security.declareProtected(Permissions.FTP, 'manage_FTPget') def manage_FTPget(self): """ @@ -1004,7 +1004,7 @@ def split(self): here and there. """ return self.pageType().split(self) - + security.declareProtected(Permissions.Delete, 'merge') def merge(self): """ @@ -1014,6 +1014,6 @@ def merge(self): text page type does this. """ return self.pageType().merge(self) - + InitializeClass(PageEditingSupport) diff --git a/Extensions/Install.py b/Extensions/Install.py index 373243c..24f9783 100644 --- a/Extensions/Install.py +++ b/Extensions/Install.py @@ -20,12 +20,12 @@ def install(portal): portal_skins = getToolByName(portal, 'portal_skins') portal_workflow = getToolByName(portal, 'portal_workflow') portal_setup = getToolByName(portal, 'portal_setup') - + portal_setup.runAllImportStepsFromProfile('profile-ZWiki:default') # XXX move the following into the profile above.. cf # http://dev.plone.org/plone/browser/CMFPlone/trunk/profiles/default/types/Discussion_Item.xml - + # register our skin layer(s) and add to each existing skin if 'zwiki' not in portal_skins.objectIds(): addDirectoryViews(portal_skins, 'skins', {'__name__':'Products.ZWiki'}) @@ -50,7 +50,7 @@ def install(portal): portal_workflow._chains_by_type = cbt out.write("Disabled workflow on Wiki Page\n") - # make wiki pages use External Editor, if installed, + # make wiki pages use External Editor, if installed, if safe_hasattr(portal.Control_Panel.Products, 'ExternalEditor'): # XXX Uses addAction and portal_migration, which are plonisms. # How should we do this for vanilla CMF ? Do nothing for now. @@ -58,7 +58,7 @@ def install(portal): migrationtool = getToolByName(portal, 'portal_migration') for ctype in portal_types.objectValues(): if ctype.getId() == 'Wiki Page': - # We must detect plone 1 or plone 2 here because addAction has a + # We must detect plone 1 or plone 2 here because addAction has a # different number of arguments # XXX actually I'm pretty sure we don't/don't need to support plone 1 # any more, check diff --git a/Extensions/Install_tests.py b/Extensions/Install_tests.py index 2d72e42..cd3346d 100644 --- a/Extensions/Install_tests.py +++ b/Extensions/Install_tests.py @@ -21,7 +21,7 @@ def install_via_external_method(site): site.manage_addProduct['ExternalMethod'].manage_addExternalMethod( 'installzwiki','','ZWiki.Install','install') site.installzwiki(site) - + def test_suite(): suite = unittest.TestSuite() suite.addTest(unittest.makeSuite(Tests)) diff --git a/History.py b/History.py index c7f2f00..0781a04 100644 --- a/History.py +++ b/History.py @@ -48,12 +48,12 @@ def revisionsFolder(self): if f.isPrincipiaFolderish: return f return None - + security.declareProtected(Permissions.View, 'revisions') def revisions(self): """ Get a list of this page's revisions, oldest first. - + A page's revisions are all the page objects with the same root id plus a possible dot-number suffix. The one with no suffix is the latest revision, kept in the main wiki folder; older revisions diff --git a/Mail.py b/Mail.py index 6880a92..90a1a9f 100644 --- a/Mail.py +++ b/Mail.py @@ -52,7 +52,7 @@ class PageSubscriptionSupport: def _getSubscribers(self, parent=0): # -> [string]; depends on self, folder; modifies self, folder """ Return a copy of this page's subscriber list, as a list. - + With parent flag, manage the parent folder's subscriber list instead. """ if AUTO_UPGRADE: self._upgradeSubscribers() @@ -66,7 +66,7 @@ def _getSubscribers(self, parent=0): # -> [string]; depends on self, folder; mod def _setSubscribers(self, subscriberlist, parent=0): # -> none; depends on self, folder; modifies self, folder """ - Set this page's subscriber list. + Set this page's subscriber list. With parent flag, manage the parent folder's subscriber list instead. """ if AUTO_UPGRADE: self._upgradeSubscribers() @@ -88,7 +88,7 @@ def _upgradeSubscribers(self): # -> none; depends on self, folder; modifies self Called as needed, ie on each access and also from ZWikiPage.upgrade() (set AUTO_UPGRADE=0 in Default.py to disable). - + XXX Lord have mercy! couldn't this be simpler """ # upgrade the folder first; we'll check attributes then properties @@ -181,7 +181,7 @@ def _upgradeSubscribers(self): # -> none; depends on self, folder; modifies self ## page subscription api ############################################# # XXX rename to subscribers() & wikiSubscribers() ? - # XXX and add editSubscribers & wikiEditSubscribers + # XXX and add editSubscribers & wikiEditSubscribers def subscriberList(self, parent=0, edits=0): # -> [string]; depends on self, folder """ Return a list of this page's subscribers, without the :edits suffix. @@ -220,7 +220,7 @@ def isSubscriber(self, email, parent=0): # -> boolean; depends on self, folder (usernames and (sub in usernames))): return 1 return 0 - + def subscribe(self, email, REQUEST=None, parent=0, edits=0): # -> none; redirects; depends on self, folder; modifies self, folder, catalog """ Add an email subscriber to this page. @@ -387,7 +387,7 @@ def usernameOrEmailOfSubscriber(self): # -> string; depends on cmf/plone site, r def emailAddressFrom(self,subscriber): # -> string; depends on cmf/plone site """ Convert a zwiki subscriber list entry to an email address. - + A zwiki subscriber list entry can be: an email address, or a CMF member id (if we are in a CMF/Plone site), or either of those with ':edits' appended. We figure out the bare email address and @@ -465,7 +465,7 @@ def usernamesFrom(self,subscriber): # -> [string] #except AttributeError: # pass #return usernames - + InitializeClass(PageSubscriptionSupport) class PageMailSupport: @@ -496,7 +496,7 @@ def fromProperty(self): # -> string; depends on self, folder Usually acquires from the folder. """ return getattr(self,'mail_from','') - + def replyToProperty(self): # -> string; depends on self, folder """ Give the mail_replyto property for this page. @@ -504,7 +504,7 @@ def replyToProperty(self): # -> string; depends on self, folder Usually acquires from the folder. """ return getattr(self,'mail_replyto','') - + def toProperty(self): # -> string; depends on self, folder """ Give the mail_to property for this page. @@ -512,7 +512,7 @@ def toProperty(self): # -> string; depends on self, folder Usually acquires from the folder. """ return getattr(self,'mail_to','') - + def fromHeader(self,REQUEST=None): # -> string; depends on self, folder """ Give the appropriate From: header for mail-outs from this page. @@ -534,13 +534,13 @@ def replyToHeader(self): # -> string; depends on self, folder Give the appropriate Reply-to: header for mail-outs from this page. """ return self.replyToProperty() or self.fromProperty() - + def listId(self): # -> string; depends on self, folder """ Give the "list id" for mail-outs from this page. """ return self.fromProperty() or self.replyToProperty() - + def listPostHeader(self): # -> string; depends on self, folder """ Give the appropriate List-Post: header for mail-outs from this page. @@ -630,7 +630,7 @@ def signature(self, message_id=None): # -> string; depends on self, folder url = self.pageUrl() if message_id: # sync with makeCommentHeading - url += '#msg%s' % re.sub(r'^<(.*)>$',r'\1',message_id) + url += '#msg%s' % re.sub(r'^<(.*)>$',r'\1',message_id) return getattr(self.folder(),'mail_signature', '--\nforwarded from %s' % url) # XXX i18n @@ -664,7 +664,7 @@ def sendMailToSubscribers(self, text, REQUEST, subjectSuffix='', exclude_address=None): # -> none; depends on self, wiki, mailhost; other effects: sends mail """ Send mail to this page's and the wiki's subscribers, if any. - + If a mailhost and mail_from property have been configured and there are subscribers to this page, email text to them. So as not to prevent page edits, catch any mail-sending errors (and log them @@ -695,7 +695,7 @@ def sendMailToEditSubscribers(self, text, REQUEST, subjectSuffix='', exclude_address=None): # -> none; depends on self, wiki, mailhost; other effects: sends mail """ Send mail to this page's and the wiki's all edits subscribers, if any. - + Like sendMailToSubscribers, but sends only to the subscribers who have requested notification of all edits. If text is empty, send nothing. @@ -722,7 +722,7 @@ def sendMailToEditSubscribers(self, text, REQUEST, subjectSuffix='', message_id=message_id, in_reply_to=in_reply_to, exclude_address=exclude_address) - + def sendMailTo(self, recipients, text, REQUEST, subjectSuffix='', subject='', @@ -765,9 +765,9 @@ def sendMailTo(self, recipients, text, REQUEST, } GenericMailHost(self.mailhost()).send(fields) BLATHER('sent mail to subscribers:\nTo: %s\nBcc: %s' % (fields['To'],fields['Bcc'])) - except: + except: BLATHER('**** failed to send mail to %s: %s' % (recipients,formattedTraceback())) - + InitializeClass(PageMailSupport) class GenericMailHost: @@ -848,9 +848,9 @@ def mailin(self, msg): # -> string | none; depends on self, wiki; modifies wiki # # handle the mail-out ourselves, to pass through the original message # m.destpage.sendMailToSubscribers( # m.original, -# self.REQUEST, +# self.REQUEST, # subject=subjectPrefix+subject, -# message_id=m.messageid, +# message_id=m.messageid, # in_reply_to=m.inreplyto, # # mailing list support: when a list and wiki are mutually subscribed, # # and a mail comes in from the list, we want to forward it out to all @@ -870,7 +870,7 @@ def defaultMailinPageName(self): # -> string | none; depends on self, folder return self.folder().default_mailin_page or None else: return self.pageName() - + InitializeClass(PageMailinSupport) class MailIn: @@ -934,7 +934,7 @@ def __init__(self, context, message): # -> none except (StopIteration, UnicodeDecodeError): payloadutf8 = '' self.body = cleanupBody(payloadutf8) - + def decideMailinAction(self): # -> (string, string|none); depends on: self, wiki context """ Figure out what to do with this mail-in. Returns an (action, info) @@ -953,7 +953,7 @@ def decideMailinAction(self): # -> (string, string|none); depends on: self, wiki - if the recipient looks like a tracker mailin address (.*TRACKERADDREXP), CREATE AN ISSUE PAGE. - - identify the destination page name: the last [bracketed page name] + - identify the destination page name: the last [bracketed page name] in the message subject, or the folder's default_mailin_page property (possibly acquired) or the current page (unless default_mailin_page was blank in which case DISCARD.) diff --git a/Makefile b/Makefile index 9a28ce1..4963f2a 100644 --- a/Makefile +++ b/Makefile @@ -56,7 +56,7 @@ epydoc: # https://translations.launchpad.net/zwiki/trunk/+pots/zwiki/+upload # wait for upload (https://translations.launchpad.net/zwiki/trunk/+imports) # 2. download latest translations from launchpad -# https://translations.launchpad.net/zwiki/trunk/+pots/zwiki/+export (everything, partial po format) +# https://translations.launchpad.net/zwiki/trunk/+pots/zwiki/+export (everything, partial po format) # https://translations.launchpad.net/zwiki/trunk/+pots/zwiki-plone/+export # wait for mail, unpack download links into i18n/ : # cd i18n @@ -94,7 +94,7 @@ poupload: for L in $(LANGUAGES); do tar rvf zwiki.tar $$L.po; done; \ tar rvf zwiki.tar zwiki-plone.pot; \ for L in $(LANGUAGES); do tar rvf zwiki.tar plone-$$L.po; done; \ - gzip -f zwiki.tar; + gzip -f zwiki.tar; # unpack po files downloaded from launchpad po: diff --git a/Outline.py b/Outline.py index 27633fe..ec25b9d 100644 --- a/Outline.py +++ b/Outline.py @@ -59,7 +59,7 @@ def updateChildmap(self,reset=0): childmap = {} else: # backwards compatibility: 0.39 might have set this to None - childmap = self.childmap() or {} + childmap = self.childmap() or {} # remove any no-longer-existing nodes from childmap for p in childmap.keys()[:]: if not p in nodes: del childmap[p] @@ -139,11 +139,11 @@ def reparent(self,node,newparents,update=1): """ Change node's parents to newparents in the outline. """ - # help prepare childmap for updateChildMap + # help prepare childmap for updateChildMap childmap = self.childmap() for p in self.parents(node): childmap[p].remove(node) self.setChildmap(childmap) - + self.add(node,newparents,update) def reorder(self,node,child=None): """ @@ -271,7 +271,7 @@ def ancestorsAndChildren(self,node): """ # Go up, identifying all and topmost forebears: ancestors = {} - tops = {} + tops = {} todo = {node: None} while todo: doing = todo @@ -305,7 +305,7 @@ def firstParent(self,node): parents = self.parentmap().get(node,None) if parents: return parents[0] else: return None - def siblings(self,node,include_me=False,sort_alpha=True): + def siblings(self,node,include_me=False,sort_alpha=True): """ Return a nesting/list representing node's siblings. @@ -340,7 +340,7 @@ def offspring(self,nodes,did=None,depth=None): If depth is specified, descendendants beyond that depth will be ignored. XXX this is better done in the view layer, remove it. - + """ if did is None: did = {} got = [] @@ -364,7 +364,7 @@ def offspring(self,nodes,did=None,depth=None): return got # never index this object, so find all object in the catalog doesn't break def index_object(self,idxs=[],log=1): pass - + # helper functions def descend_ancestors(page, ancestors, did, children): diff --git a/OutlineSupport.py b/OutlineSupport.py index 46011d8..90a1c42 100644 --- a/OutlineSupport.py +++ b/OutlineSupport.py @@ -152,7 +152,7 @@ def setParents(self,parents): def addParent(self,parent): if parent: # we sometimes start page names with space as a subtopic - # ordering hack.. + # ordering hack.. #parent = string.strip(parent) if parent and not parent in self.parents: self.ensureParentsPropertyIsList() @@ -185,12 +185,12 @@ def ensureValidParents(self): cleanedupparents.sort() # if changed, save and reindex if cleanedupparents != parents: - BLATHER("adjusting %s's parents from %s to %s" % + BLATHER("adjusting %s's parents from %s to %s" % (self.pageName(), parents, cleanedupparents)) self.setParents(cleanedupparents) self.index_object() #XXX only need to update parents index & metadata -InitializeClass(ParentsProperty) +InitializeClass(ParentsProperty) class ShowSubtopicsProperty: @@ -304,9 +304,9 @@ def ensureWikiOutline(self): or it it's a pre-0.61 non-unicode outline, rebuild it. """ o = safe_hasattr(self.folder().aq_base,'outline') and self.folder().outline or None - if not o: + if not o: self.rebuildWikiOutline() - + security.declareProtected(Permissions.View, 'updateWikiOutline') def updateWikiOutline(self): @@ -350,7 +350,7 @@ def updateWikiOutline(self): # easier-to-type alias updatecontents = updateWikiOutline - + security.declareProtected(Permissions.View, 'rebuildWikiOutline') def rebuildWikiOutline(self): """Regenerate the wiki folder's cached outline object, throwing away @@ -382,10 +382,10 @@ def reparent(self, parents=[], REQUEST=None, pagename=None): # page mgmt form must use pagename field: pagename = pagename and self.tounicode(pagename) if pagename: - parents = [pagename] + parents = [pagename] # or parents might be a string elif type(parents) != ListType: - parents = [parents] + parents = [parents] # empty strings are common, remove before calling pageWithFuzzyName parents = filter(lambda x:x, parents) # to unicode @@ -401,9 +401,9 @@ def reparent(self, parents=[], REQUEST=None, pagename=None): uniqueparents = [] for p in parents: if not p in uniqueparents: uniqueparents.append(p) - + # finally - update our parents property, the outline cache, and catalog - self.setParents(uniqueparents) + self.setParents(uniqueparents) self.wikiOutline().reparent(self.pageName(),uniqueparents) self.index_object() @@ -743,7 +743,7 @@ def context(self, REQUEST=None, with_siblings=0, enlarge_current=0): self.setParents([]) self.index_object() hierarchy = self.renderNesting( - nesting, here, + nesting, here, enlarge_current=enlarge_current, suppress_hyperlink=suppress_hyperlink) # if a SiteMap page exists, point the contents link there @@ -872,11 +872,11 @@ def renderNesting(self, nesting, here=None, enlarge_current=0, (backwards compatibility for old editforms) - if suppress_current is true, here will not be shown at all - did, got & indent are for recursion, callers should not use - + Do we need all this complicated code, can't we do it in the skin template ? I think so, except for two issues: for very large nestings the python version might be perceptibly quicker; and, - it's easier to recurse with python. See also nestingAsRenderList. + it's easier to recurse with python. See also nestingAsRenderList. """ # XXX oh yeah.. kludgorama def renderContentsLink(page): @@ -887,7 +887,7 @@ def quicklink(page): id = self.canonicalIdFrom(page) return u'%s' \ % (wikiurl,id,id,self.formatWikiname(page)) - if here and page == here: + if here and page == here: if enlarge_current: # just assume we are in the page header, and link to # backlinks as well as enlarging @@ -908,7 +908,7 @@ def quicklink(page): else: #return self.renderLinkToPage(page,name=page) return quicklink(page) - + #XXX cleanup if suppress_current and nesting[0] == here: # a single childless page return '' @@ -972,20 +972,20 @@ def nestingAsRenderList(self, nesting, here=None, suppress_current=0, which is stored as a nesting like:: - [['AnnoyingQuote', ['AnnoyingQuoteArchive', 'AngryDenial'], 'AnnoyingQuoteDiscussion']] + [['AnnoyingQuote', ['AnnoyingQuoteArchive', 'AngryDenial'], 'AnnoyingQuoteDiscussion']] gets converted to a render list like:: [ - {'type': '+'}, - {'href': 'zwikib/AnnoyingQuote', 'type': '=', 'page': 'AnnoyingQuote', 'name': 'AnnoyingQuote'}, - {'type': '+'}, - {'href': 'zwikib/AnnoyingQuoteArchive', 'type': '=', 'page': 'AnnoyingQuoteArchive', 'name': 'AnnoyingQuoteArchive'}, - {'type': '+'}, - {'href': 'zwikib/AngryDenial', 'type': '=', 'page': 'AngryDenial', 'name': 'AngryDenial'}, - {'type': '-'}, - {'href': 'zwikib/AnnoyingQuoteDiscussion', 'type': '=', 'page': 'AnnoyingQuoteDiscussion', 'name': 'AnnoyingQuoteDiscussion'}, - {'type': '-'}, + {'type': '+'}, + {'href': 'zwikib/AnnoyingQuote', 'type': '=', 'page': 'AnnoyingQuote', 'name': 'AnnoyingQuote'}, + {'type': '+'}, + {'href': 'zwikib/AnnoyingQuoteArchive', 'type': '=', 'page': 'AnnoyingQuoteArchive', 'name': 'AnnoyingQuoteArchive'}, + {'type': '+'}, + {'href': 'zwikib/AngryDenial', 'type': '=', 'page': 'AngryDenial', 'name': 'AngryDenial'}, + {'type': '-'}, + {'href': 'zwikib/AnnoyingQuoteDiscussion', 'type': '=', 'page': 'AnnoyingQuoteDiscussion', 'name': 'AnnoyingQuoteDiscussion'}, + {'type': '-'}, {'type': '-'} ] @@ -1044,7 +1044,7 @@ def nestingAsRenderList(self, nesting, here=None, suppress_current=0, if not (n[0]==here and suppress_current): #XXX temp got.append( {'type':'-'} ) else: - + got[-1]['type'] += '.' # a parent whose children were omitted else: t = (n==here and '=!' or '=') @@ -1059,7 +1059,7 @@ def nestingAsRenderList(self, nesting, here=None, suppress_current=0, if '=' in g['type'] : g['href'] = wikiurl + '/' + self.canonicalIdFrom(g['page']) g['name'] = quote(g['page']) - + return got # backwards compatibility @@ -1070,7 +1070,7 @@ def nestingAsRenderList(self, nesting, here=None, suppress_current=0, class PageOutlineSupport( ParentsProperty, ShowSubtopicsProperty, - OutlineManager, + OutlineManager, OutlineRendering ): """ diff --git a/README.txt b/README.txt index a904292..6697dd9 100644 --- a/README.txt +++ b/README.txt @@ -1,13 +1,13 @@ README ###### -A wiki engine for Zope. +A wiki engine for Zope. For documentation and assistance, please see http://zwiki.org . All feedback, bug reports and other help appreciated. (c) 1999-2009 Simon Michael and contributors. -This product is released under the GNU General Public License. +This product is released under the GNU General Public License. All rights reserved, all disclaimers apply, etc. Overview of documentation files:: @@ -18,7 +18,7 @@ Overview of documentation files:: FILESYSTEM_VS_WIKI_DOCS meta-documentation LICENSE license text LINECOUNTS code line counts (generated by make linecount) - REPO_POLICY policy for the main Zwiki repository + REPO_POLICY policy for the main Zwiki repository STYLE developer style guide TESTS test notes diff --git a/Regexps.py b/Regexps.py index 32577fc..0082f18 100644 --- a/Regexps.py +++ b/Regexps.py @@ -128,7 +128,7 @@ Ubr = '[%s]' % ''.join([c.encode('utf8') for c in unicode(uppercase,'utf-8')]) Lbr = '[%s]' % ''.join([c.encode('utf8') for c in unicode(lowercase,'utf-8')]) relocaleflag = '' - wordboundary = '(?[^\s]*)\s*$' protected_line = r'(?m)^!(.*)$' -# stx footnotes +# stx footnotes # handled by us so as to co-exist with our bracketed links # real stx allows refchars = r'[0-9_%s-]' % (string.letters) footnoteexpr = r'(?sm)^\.\. \[([^\n\]]+)\]' diff --git a/TextFormatter.py b/TextFormatter.py index dc48816..8be109c 100644 --- a/TextFormatter.py +++ b/TextFormatter.py @@ -97,7 +97,7 @@ def wrap(self, text): words.append(word[i:i+self.width]) words.append('\n') if words[-1] == '\n': words.pop() - + if words: current = words.pop(0) for word in words: diff --git a/Utils.py b/Utils.py index 4a4e8a6..43bcf21 100644 --- a/Utils.py +++ b/Utils.py @@ -94,7 +94,7 @@ class PageUtils: ###################################################################### # misc security utilities - + def checkPermission(self, permission, object): return getSecurityManager().checkPermission(permission,object) @@ -206,7 +206,7 @@ def renderedSummary(self,size=500,paragraphs=1): self.pageType().format( self, self.summary(size=size, paragraphs=paragraphs)))) - + security.declareProtected(Permissions.View, 'excerptAt') def excerptAt(self, expr, size=100, highlight=1, text=None): # -> html string | empty string # depends on: self (if no text provided) @@ -277,7 +277,7 @@ def getObject(self): return self._obj except (ImportError, AttributeError): setattr(brain, attr, None) #XXX not using now.. leave blank so tests pass - brain.linkTitle = '' + brain.linkTitle = '' return brain def ensureCompleteMetadataIn(self,brain): @@ -353,7 +353,7 @@ def wikiUrl(self): def wikiPath(self): """Return the path part of this wiki's url. """ - # absolute_url_path and virtual_url_path just don't work + # absolute_url_path and virtual_url_path just don't work # in a apache proxy-vhm-zope situation, apparently. #try: return self.folder().absolute_url_path() try: return re.sub(r'.*?//.*?/',r'/',self.folder().absolute_url()) @@ -383,7 +383,7 @@ def urlForDtmlPageOrMethod(self,pagename,methodname): situation. """ p = self.pageWithName(pagename) - return ((p and p.dtmlAllowed() and p.hasDynamicContent() and p.pageUrl()) + return ((p and p.dtmlAllowed() and p.hasDynamicContent() and p.pageUrl()) or self.defaultPage().pageUrl()+'/'+methodname) # XXX keeping these page names in the skin might be easier for i18n ? @@ -413,7 +413,7 @@ def contentsUrl(self, scroll=1): url = self.defaultPageUrl() + '/contents' if scroll: url += '#' + self.pageId() return url - + security.declareProtected(Permissions.View, 'changesUrl') def changesUrl(self): return self.urlForDtmlPageOrMethod('RecentChanges','recentchanges') @@ -550,9 +550,9 @@ def asAgeString(self,time): # -> string | empty string minutes=int(math.floor((elapsed-days-hourfactor*hours)/minutefactor)) seconds=int(round(( elapsed-days-hourfactor*hours-minutefactor*minutes)/secondsfactor)) - + datepattern = ("%(nb)d %(period)s") - + if years: s = datepattern % {"nb": years, "period": years > 1 and _('years') or _('year')} elif months: @@ -567,7 +567,7 @@ def asAgeString(self,time): # -> string | empty string s = datepattern % {"nb":minutes, "period":minutes > 1 and _('minutes') or _('minute')} else: s = datepattern % {"nb":seconds, "period":seconds > 1 and _('seconds') or _('second')} - + return s security.declareProtected(Permissions.View,'include') @@ -582,7 +582,7 @@ def include(self,page,REQUEST=None, **kw): p = self.pageWithNameOrId(page) if p: return p(bare=1,REQUEST=REQUEST, **kw) else: return '' - + def isBoring(self): """ Is this page one which should be quieter, eg test pages ? @@ -614,7 +614,7 @@ def talsafe(self,s): our standard encoding. (cf issue #1330) This is idempotent, safe to call repeatedly. - """ + """ if ZOPEVERSION < (2,10): return s else: return self.tounicode(s) @@ -627,7 +627,7 @@ def talsafe(self,s): # but it's already done so let's leave it this way for a bit. def encoding(self): return 'utf-8' - + def toencoded(self,s,enc=None): """Safely convert a unicode string to an encoded ordinary string. The wiki's default encoding is used, unless overridden. @@ -693,7 +693,7 @@ def base_hasattr(obj, name): """Like safe_hasattr, but also disables acquisition.""" return safe_hasattr(aq_base(obj), name) -def html_quote(s): +def html_quote(s): s = re.sub(r'&','&',s) s = re.sub(r'<','<',s) s = re.sub(r'>','>',s) @@ -983,7 +983,7 @@ def nub(l): for v in l: if not v in u: u.append(v) return u - + isnumeric = lambda v:isinstance(v,IntType) or isinstance(v,FloatType) or isinstance(v,LongType) isfloat = lambda v:isinstance(v,FloatType) isstring = lambda v:isinstance(v,StringType) diff --git a/Views.py b/Views.py index 5eca1c0..ab78846 100644 --- a/Views.py +++ b/Views.py @@ -332,12 +332,12 @@ class SkinUtils: # XXX should be going away soon. Old comment: the wikipage template # is usually applied by __call__ -> addSkinTo, but this method is # provided so you can configure it as the"view" action - # in portal_types -> Wiki Page -> actions and get use Zwiki's standard + # in portal_types -> Wiki Page -> actions and get use Zwiki's standard # skin inside a CMF/Plone site. # """ # return self.render(REQUEST=REQUEST,RESPONSE=RESPONSE) #wikipage_view = wikipage - + # backwards compatibility - some old templates expect # wikipage_template().macros or wikipage_macros something something def wikipage_template(self, REQUEST=None): return self @@ -394,18 +394,18 @@ def getSkinTemplate(self, name, suffixes=['.pt','.dtml','']): """ # look for a similarly-named template.. obj = None - + # in a filesystem skin named by a "skin" request var skin = self.REQUEST.get('skin',None) if SKINS.has_key(skin): obj = SKINS[skin].get(name,None) - + #in the zodb if not obj: for s in suffixes: obj = getattr(self.folder(), name+s, None) if obj and (isTemplate(obj) or isFile(obj)): break else: obj = None - + # in a filesystem skin named by a "skin" property if not obj: skin = getattr(self,'skin',None) @@ -416,7 +416,7 @@ def getSkinTemplate(self, name, suffixes=['.pt','.dtml','']): # or give up and show a harmless error if not obj: obj = SKINS['zwiki']['badtemplate'] - + # return it, with both folder and page in the acquisition context return obj.__of__(self.folder()).__of__(self) @@ -426,7 +426,7 @@ def hasSkinTemplate(self,name): """ # != ignores any acquisition wrapper return self.getSkinTemplate(name) != TEMPLATES['badtemplate'] - + security.declareProtected(Permissions.View, 'addSkinTo') def addSkinTo(self,body,**kw): """ @@ -509,7 +509,7 @@ def usingPloneSkin(self,REQUEST=None): Ie, are we using the plone display mode of zwiki's standard skin. """ return (self.inCMF() and self.displayMode()=='plone') - + security.declareProtected(Permissions.View, 'setCMFSkin') def setCMFSkin(self,REQUEST,skin): """ diff --git a/ZWikiPage.py b/ZWikiPage.py index aefeb7b..328ff57 100644 --- a/ZWikiPage.py +++ b/ZWikiPage.py @@ -56,11 +56,11 @@ DEFAULT_PAGETYPE = PAGETYPES[0] -# see plugins/__init__.py +# see plugins/__init__.py # # PageCMFSupport is last to avoid PortalContent.id overriding # DTMLDocument.id() as older code expects ZWikiPage.id() to be callable. -class ZWikiPage( +class ZWikiPage( PLUGINS[0], PLUGINS[1], PLUGINS[2], @@ -78,7 +78,7 @@ class ZWikiPage( PLUGINS[14], PLUGINS[15], ArchiveSupport, - PageEditingSupport, + PageEditingSupport, PageOutlineSupport, PageDiffSupport, PageHistorySupport, @@ -158,13 +158,13 @@ def dummy2(self): pass last_log = '' revision_number = 1 PAGE_TYPES = PAGE_TYPES # used by skin templates - # page_type used to be a string used to select a render method. + # page_type used to be a string used to select a render method. # As of 0.25 it is an object which encapsulates the page's formatting # behaviour. It will return the old id string when called, which # should keep existing catalogs working. page_type = DEFAULT_PAGETYPE() # pre-rendered text cache - _prerendered = '' + _prerendered = '' def __unicode__(self): return self.tounicode(self.read()) @@ -268,7 +268,7 @@ def render(self, client=None, REQUEST={}, RESPONSE=None, **kw): def preRender(self,clear_cache=0): """ Make sure any applicable pre-rendering for this page has been done. - + If clear_cache is true, blow away any cached data. XXX I think this happens anyway. """ @@ -281,7 +281,7 @@ def renderText(self, text, type, **kw): Render some source text according to the specified page type. """ return self.lookupPageType(type)().renderText(self,text,**kw) - + security.declareProtected(Permissions.View, 'clearCache') def clearCache(self,REQUEST=None): """ @@ -329,7 +329,7 @@ def evaluatePreRenderedAsDtml(self,client=None, REQUEST={}, # cook encoded it for safe passage through the DTML monster t = self.tounicode(t) return t - + def renderMidsectionIn(self, text, **kw): """ Insert some final things between the rendered document and discussion. @@ -340,7 +340,7 @@ def renderMidsectionIn(self, text, **kw): XXX This is not good enough. The midsection marker can get mixed up with other rendering in the various page types. - + """ # page may not have been prerendered with midsection marker yet - # we'll also insert at a messages separator, if we see one, @@ -349,8 +349,8 @@ def renderMidsectionIn(self, text, **kw): try: doc, discussion = re.split(MIDSECTIONMARKER,text) except ValueError: #our marker got clobbered, or there's more than one - bail out - return text - + return text + elif string.find(text,r'') != -1: doc, discussion = re.split(r'',text) discussion = '' + discussion @@ -379,29 +379,29 @@ def displaysSubtopicsWithDtml(self): self.dtmlAllowed() and (re.search(r'(?i)(]+subtopics|&dtml-subtopics)', self.read()) is not None)) - + security.declareProtected(Permissions.View, 'supportsStx') - def supportsStx(self): - """supportsStx""" + def supportsStx(self): + """supportsStx""" return self.pageType().supportsStx() security.declareProtected(Permissions.View, 'supportsRst') - def supportsRst(self): - """supportsRst""" + def supportsRst(self): + """supportsRst""" return self.pageType().supportsRst() security.declareProtected(Permissions.View, 'supportsWikiLinks') - def supportsWikiLinks(self): + def supportsWikiLinks(self): """supportsWikiLinks""" return self.pageType().supportsWikiLinks() security.declareProtected(Permissions.View, 'supportsHtml') - def supportsHtml(self): + def supportsHtml(self): """Does this page render ordinary HTML tags ?""" return self.pageType().supportsHtml() security.declareProtected(Permissions.View, 'supportsDtml') - def supportsDtml(self): + def supportsDtml(self): """Does this page support embedded DTML ?""" return self.pageType().supportsDtml() @@ -430,7 +430,7 @@ def handle_modified_headers(self, last_mod=None, REQUEST=None): """ RESPONSE = getattr(REQUEST,'RESPONSE',None) if not RESPONSE:return False - RESPONSE.setHeader('Cache-Control', + RESPONSE.setHeader('Cache-Control', 'max-age=86400, s-maxage=86400, public, must-revalidate, proxy-revalidate') # do we handle things at all? if not getattr(self, 'conditional_http_get', CONDITIONAL_HTTP_GET): @@ -440,7 +440,7 @@ def handle_modified_headers(self, last_mod=None, REQUEST=None): # especially useful for ignoring pages with allow_dtml ignore = getattr( self, 'conditional_http_get_ignore', CONDITIONAL_HTTP_GET_IGNORE) - + for ignore_property in ignore: if getattr(self, ignore_property, False): return False if last_mod == None: @@ -603,7 +603,7 @@ def applyWikiLinkLineEscapesIn(self, text): protected_line, lambda m:re.sub(wikilink, r'!\1', m.group(1)), text) - + def renderLink(self,link,state=None,text='',link_title=None,access_key=None): """ Render various kinds of hyperlink, based on page and wiki state. @@ -716,7 +716,7 @@ def linkTargetAndLabel(link): # XXX helper for above def renderLinkToPage(self,page,linkorig=None,link_title=None, access_key=None,name=None,label=None): - + """ Render a wiki link to page, which may or may not exist. @@ -787,7 +787,7 @@ def _replaceLinksInSourceText(self,oldlink,newlink,text): # -> string; depends o """ Replace occurrences of oldlink with newlink in a string. - Depends on: allowed link styles (brackets etc.) on this wiki + Depends on: allowed link styles (brackets etc.) on this wiki or the current wiki page Freeform links given should not be enclosed in brackets. @@ -851,7 +851,7 @@ def formatWikiname(self,wikiname): """ if self.spacedWikinamesEnabled(): return self.spacedNameFrom(wikiname) - else: + else: return wikiname security.declareProtected(Permissions.View, 'spacedNameFrom') @@ -921,7 +921,7 @@ def linkTitle(self,prettyprint=0): def linkTitleFrom(self,last_edit_time=None,last_editor=None,prettyprint=0): """ make a link title string from these last_edit_time and editor strings - + with prettyprint=1, format it for use in the standard header. """ try: @@ -941,7 +941,7 @@ def linkTitleFrom(self,last_edit_time=None,last_editor=None,prettyprint=0): ' %s' % ( self.pageUrl(), _('show last edit'), - lastlog, + lastlog, interval)) # use the link in a clear i18n way @@ -957,9 +957,9 @@ def linkTitleFrom(self,last_edit_time=None,last_editor=None,prettyprint=0): if not prettyprint: s = s + " " + _("by %(editor)s")% {"editor":editor} else: - s = s + " " + _("by %(editor)s") % {"editor":"%s" % editor} + s = s + " " + _("by %(editor)s") % {"editor":"%s" % editor} return s - + def linkToAllCataloged(self): return getattr(self,'link_to_all_cataloged', LINK_TO_ALL_CATALOGED) and 1 @@ -983,7 +983,7 @@ def pageName(self): def pageId(self): return self.id() - + security.declareProtected(Permissions.View, 'spacedPageName') def spacedPageName(self): """ @@ -992,7 +992,7 @@ def spacedPageName(self): We use this for eg the html title tag to improve search engine relevance. """ return self.spacedNameFrom(self.pageName()) - + security.declareProtected(Permissions.View, 'formattedPageName') def formattedPageName(self): """ @@ -1038,7 +1038,7 @@ def canonicalIdFrom(self,name): # ' is not considered a word boundary. name = re.sub(r"'",r"",name) name = re.sub(r'[%s]+'%re.escape(string.punctuation),r' ',name) - + # capitalize whitespace-separated words (preserving existing # capitals) then strip whitespace id = ' '+name @@ -1186,7 +1186,7 @@ def pageNamesMatching(self,text): def defaultPage(self): """ Return this wiki's default page object, where eg mail goes by default. - + That is: - a page named in the default_page string or lines property @@ -1196,7 +1196,7 @@ def defaultPage(self): """ # default_page property could be a list, tuple or string default_page_names = getattr(self.folder(),'default_page',[]) - if type(default_page_names) == StringType: + if type(default_page_names) == StringType: default_page_names = [default_page_names] elif type(default_page_names) == TupleType: default_page_names = list(default_page_names) @@ -1206,13 +1206,13 @@ def defaultPage(self): if p: return p # pageObjects could be a LazyMap return (list(self.pageObjects())+[None])[0] - + security.declareProtected(Permissions.View, 'defaultPageId') def defaultPageId(self): """ Return this wiki's default page ID. - - See defaultPage. + + See defaultPage. """ p = self.defaultPage() return (p and p.id()) or None @@ -1282,13 +1282,13 @@ def pageWithNameOrId(self,name,url_quoted=0): """ Return the page in this folder with this as it's name or id, or None. """ - return (self.pageWithId(name,url_quoted) or + return (self.pageWithId(name,url_quoted) or self.pageWithName(name,url_quoted)) - + security.declareProtected(Permissions.View, 'pageWithFuzzyName') def pageWithFuzzyName(self,name,url_quoted=0,allow_partial=0, ignore_case=1, numeric_match=0): - + """ Return the page in this folder for which name is a fuzzy link, or None. @@ -1321,14 +1321,14 @@ def pageWithFuzzyName(self,name,url_quoted=0,allow_partial=0, for i in ids: ilower = i.lower() - if (ilower == idlower or + if (ilower == idlower or ((allow_partial and ilower[:len(idlower)] == idlower) and not (numeric_match and re.match(r'[0-9]',ilower[len(idlower):]))) ): return self.pageWithId(i) return None - + security.declareProtected(Permissions.View, 'backlinksFor') def backlinksFor(self, page): """ @@ -1336,7 +1336,7 @@ def backlinksFor(self, page): Optimisation: like pages(), this method used to return actual page objects but now returns metadata objects (catalog results if possible, - or workalikes) to improve caching. + or workalikes) to improve caching. page may be a name or id, and need not exist in the wiki @@ -1370,13 +1370,13 @@ def translateHelper(self,msgid,map=None): to call _("") from the python: Expression. dont forget to force i18n extraction with something like - + - + """ - + translate_msg = _(msgid) if map: try: @@ -1399,7 +1399,7 @@ def translateHelper(self,msgid,map=None): wiki_page_url = PageUtils.page_url wiki_base_url = PageUtils.wiki_url zwiki_username_or_ip = PageUtils.usernameFrom - applyLineEscapesIn = applyWikiLinkLineEscapesIn + applyLineEscapesIn = applyWikiLinkLineEscapesIn supportsEpoz = lambda x:False # CMF compatibility @@ -1438,10 +1438,10 @@ def within_literal(upto, after, state, text, lastend,inpre,incode,intag,inanchor = \ state['lastend'], state['inpre'], state['incode'], state['intag'], \ state['inanchor'] - + newintag = newincode = newinpre = newinanchor = 0 text = lower(text) - + # Check whether '
' is currently (possibly, still) prevailing.
     opening = rfind(text, ']*>(.*)',t)
diff --git a/content/basic/FrontPage.stx b/content/basic/FrontPage.stx
index 71820e9..6d755cb 100644
--- a/content/basic/FrontPage.stx
+++ b/content/basic/FrontPage.stx
@@ -1,4 +1,4 @@
-**Welcome!** 
+**Welcome!**
 
 This is the front page of ZWiki's "basic" wiki template, a small set of
 starter pages for your wiki.  "Edit":FrontPage/editform this page and
@@ -14,17 +14,17 @@ Other things you may want to configure:
 You normally configure permissions in the wiki folder's Security tab in
 the ZMI. ZWiki:QuickReference has a list.
 
-- **Mail out (subscription)** 
 
+- **Mail out (subscription)** 

 To mail out comments, use the ZMI to add a 'mail_replyto' string property
 on the folder with a valid email address. Also add a !MailHost object if
 you don't already have one.  Reload this page and the subscribe link
 should appear.
 
 - **Mail in** 

-So that users will be able to reply to comments by mail - 
+So that users will be able to reply to comments by mail -
 see ZWiki:ConfiguringWikiMail.
 
-- **External (client-side) editing** 
 
+- **External (client-side) editing** 

 
 Install ZWiki:ExternalEditor on server and client as described on that
 page. EE's pencil icon should appear and clicking it should open pages for
@@ -34,7 +34,7 @@ editing in your preferred editor.
 A simple issue tracker integrated with the wiki.  See
 ZWiki:HowToSetUpAZwikiTracker
 
-- **DTML** 
 
+- **DTML** 

 If you want to enable live DTML code in pages, add a true allow_dtml
 boolean property on the folder. This makes your server much more
 vulnerable to abuse, you should be aware of the ZWiki:SecurityDiscussion
diff --git a/content/basic/WikiWikiWeb.stx b/content/basic/WikiWikiWeb.stx
index 846b45b..48953fa 100644
--- a/content/basic/WikiWikiWeb.stx
+++ b/content/basic/WikiWikiWeb.stx
@@ -4,4 +4,4 @@ many other things.
 
 WikiWikiWeb:FrontPage
 
-RemoteWikiURL: http://c2.com/cgi/wiki? 
+RemoteWikiURL: http://c2.com/cgi/wiki?
diff --git a/content/basic/ZWiki.stx b/content/basic/ZWiki.stx
index 2711610..91789fc 100644
--- a/content/basic/ZWiki.stx
+++ b/content/basic/ZWiki.stx
@@ -1,10 +1,10 @@
-Zwiki is the software which drives this wiki site.  
+Zwiki is the software which drives this wiki site.
 It has been developed by "Joyful Systems":http://joyful.com and
-"contributors":http://zwiki.org/ZwikiContributors around the world, 
-and is available under the GNU GPL. 
+"contributors":http://zwiki.org/ZwikiContributors around the world,
+and is available under the GNU GPL.
 For more information, see http://zwiki.org .
 
 Zwiki is inspired by the original WikiWikiWeb and powered by the
-"Zope":http://zope.org web application server. 
+"Zope":http://zope.org web application server.
 
 RemoteWikiURL: http://zwiki.org/
diff --git a/content/basic/sitemap.xml.dtml b/content/basic/sitemap.xml.dtml
index c773a98..eda1843 100644
--- a/content/basic/sitemap.xml.dtml
+++ b/content/basic/sitemap.xml.dtml
@@ -1,30 +1,30 @@
 generate a wiki index in Google Sitemaps format
- 
- 
+
+
 
 
- 
-/ 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+
+/
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
diff --git a/content/basic/standard_error_message.dtml b/content/basic/standard_error_message.dtml
index 58f2bf5..1683ca8 100644
--- a/content/basic/standard_error_message.dtml
+++ b/content/basic/standard_error_message.dtml
@@ -2,13 +2,13 @@
 
 A custom error handler for 404 NotFound errors (only). Redirects to a
 similarly-named existing page if possible, otherwise offers create/search
-buttons.  
+buttons.
 
 Assumes at least one zwiki page exists. It doesn't matter which one we
 work from, except created pages will go under it. picks SandBox if
 available, to reduce mail noise from test pages.
 
-"
     

     

-      Click here to 
+      Click here to
       
/createform"
             method="GET" enctype="multipart/form-data">
         
diff --git a/i18n/__init__.py b/i18n/__init__.py
index a5c0cb8..bd278e7 100644
--- a/i18n/__init__.py
+++ b/i18n/__init__.py
@@ -71,7 +71,7 @@ class MockTranslateTag:
         blockContinuations=()
         _msgid = None
         _domain = None
-        def __init__(self, blocks): 
+        def __init__(self, blocks):
             self.blocks=blocks
             tname, args, section = blocks[0]
             self.__name__="%s %s" % (tname, args)
diff --git a/plugins/pagetypes/common.py b/plugins/pagetypes/common.py
index 17f3e2a..4b239b8 100644
--- a/plugins/pagetypes/common.py
+++ b/plugins/pagetypes/common.py
@@ -110,7 +110,7 @@ def renderText(self, page, text, **kw):
             bare=1,
             show_subtopics=0,
             show_issueproperties=0)
-    
+
     def preRenderMessages(self,page):
         t = ''
         for m in page.messages(): t += self.preRenderMessage(page,m)
@@ -145,7 +145,7 @@ def addCommentHeadingTo(self,page,text,utfmsg):
                                        ) + text
 
     def makeCommentHeading(self, page,
-                           subject, username, time, 
+                           subject, username, time,
                            message_id=None,in_reply_to=None):
         heading = '\n\n'
         heading += '%s --' % (page.tounicode(subject) or '...')
@@ -170,7 +170,7 @@ def split(self):
         """
         Move this page's top-level sections to sub-pages.
         """
-        return 
+        return
 
     def merge(self):
         """
@@ -178,7 +178,7 @@ def merge(self):
 
         This merges all offspring, not just immediate children.
         """
-        return 
+        return
 
 class PageTypeBaseHtml(PageTypeBase):
     """
@@ -187,7 +187,7 @@ class PageTypeBaseHtml(PageTypeBase):
     Override me and define _id and _name to make a usable page type
     object. See __init__.py for more.
     """
-    
+
     supportsHtml = yes
 
     def renderCitationsIn(self, page, t):
@@ -217,10 +217,10 @@ def renderCitationsIn(self, page, t):
             m = re.match(r'^>\s?(.*)$', lines[i])
             lines[i] = m.group(1)+'\n'
         t += string.join(lines[blockend:], '\n')
-        return t 
+        return t
 
     def makeCommentHeading(self, page,
-                           subject, username, time, 
+                           subject, username, time,
                            message_id=None,in_reply_to=None):
         heading = '\n\n'
         time = page.tounicode(time)
@@ -243,14 +243,14 @@ def makeCommentHeading(self, page,
         else:
             heading += html_quote(time or '')
             inreplytobit = ''
-        #heading += ( (' ' 
+        #heading += ( (' '
         #             % (page.pageUrl(),quote(subject or ''),inreplytobit)) +
         #             + _("reply") + '' )
-        
+
         heading += ' reply'\
                    % (page.pageUrl(),quote(subject or ''),inreplytobit)
 
-                     
+
         heading += '
\n'
         return heading
 
@@ -261,7 +261,7 @@ def discussionSeparator(self,page):
         # will work
         return '\n\n
%(comments)s:\n\n' % \
                { "comments":_("comments") }
-            
+
     def inlineImage(self, page, id, path):
         return '\n\n\n' % path
 
diff --git a/plugins/pagetypes/html.py b/plugins/pagetypes/html.py
index a52a5b4..b8cd75f 100644
--- a/plugins/pagetypes/html.py
+++ b/plugins/pagetypes/html.py
@@ -29,13 +29,13 @@ def render(self, page, REQUEST={}, RESPONSE=None, **kw):
         return t
 
     def makeCommentHeading(self, page,
-                           subject, username, time, 
+                           subject, username, time,
                            message_id=None,in_reply_to=None):
         """
         Generate HTML markup for a comment heading in a HTML page.
 
-        Note that we just work on the comment heading here. The content of the 
-        comment is left as is, not certain what to do with it. Users likely 
+        Note that we just work on the comment heading here. The content of the
+        comment is left as is, not certain what to do with it. Users likely
         expect to be able to write comments like on every other page type
         (e.g. with two newlines to format paragraphs) - but what kind of markup
         would be expected on a html page? XXX
diff --git a/plugins/pagetypes/rst.py b/plugins/pagetypes/rst.py
index a23cdc4..0e170fa 100644
--- a/plugins/pagetypes/rst.py
+++ b/plugins/pagetypes/rst.py
@@ -55,7 +55,7 @@ def render(self, page, REQUEST={}, RESPONSE=None, **kw):
         return t
 
     def makeCommentHeading(self, page,
-                           subject, username, time, 
+                           subject, username, time,
                            message_id=None,in_reply_to=None):
         """
         Generate restructured text markup for a comment heading in a RST page.
@@ -91,12 +91,12 @@ def discussionSeparator(self,page):
 
     def inlineImage(self, page, id, path):
         return '\n\n.. image:: %s\n' % path
-   
+
     def linkFile(self, page, id, path):
         return '\n\n!`%s`__\n\n__ %s\n' % (id, path)
 
     # split and merge.. these are trickier than they seemed at first
-    
+
     def split(self, page):
         """
         Move this page's top-level sections to sub-pages.
@@ -119,7 +119,7 @@ def split(self, page):
         page.edit(
             text=d.child_text_separator.join(
                 [p.astext() for p in d[:d.first_child_matching_class(section)]]))
-        
+
         if getattr(page,'REQUEST',None):
             page.REQUEST.RESPONSE.redirect(page.pageUrl())
 
diff --git a/plugins/pagetypes/rst_tests.py b/plugins/pagetypes/rst_tests.py
index 0c3a429..7019a5e 100644
--- a/plugins/pagetypes/rst_tests.py
+++ b/plugins/pagetypes/rst_tests.py
@@ -20,7 +20,7 @@ def test_PageTypeRst(self):
 
     def test_dtml_in_rst(self):
         p = self.p
-        
+
         # disabled by default ?
         p.edit(text='',type='rst')
         self.assert_(p.hasDynamicContent())
diff --git a/plugins/pagetypes/stx.py b/plugins/pagetypes/stx.py
index 60479f9..ad0c7d2 100644
--- a/plugins/pagetypes/stx.py
+++ b/plugins/pagetypes/stx.py
@@ -64,11 +64,11 @@ def format(self,page,t):
     def preRender(self, page, text=None):
         """
         Do as much up-front rendering work as possible and save it.
-        
+
         For the STX page type, this means: format mbox-style messages,
         apply text formatting, format any purple numbers, and identify
         wiki links.
-        
+
         This normally works on page's source, but can be also invoked on
         arbitrary text.
         """
@@ -116,7 +116,7 @@ def doc_sgml(self,s,expr=re.compile(dtmlorsgmlexpr).search):
     # so we must hard-code STX element types and priorities here..
     # should mimic STXNG behaviour as closely as possible here
     text_types = [
-        'doc_sgml',    
+        'doc_sgml',
         'doc_literal',
         'doc_img',
         'doc_inner_link',
@@ -274,7 +274,7 @@ def doc_table(self, paragraph,
         for div in dividers:
             if div in TD:
                 index = all.index(div)
-                for rowindex in range(all[index-1],all[index]):                    
+                for rowindex in range(all[index-1],all[index]):
                     for i in range(len(rows[rowindex])):
                         rows[rowindex][i] = (rows[rowindex][i][0],
                                              rows[rowindex][i][1],
@@ -319,7 +319,7 @@ def doc_table(self, paragraph,
                 leftindent      = 0
                 rightindent     = 0
                 left            = []
-                right           = []                                    
+                right           = []
                 text            = row[index][0]
                 text            = split(text,'\n')
                 text            = text[:len(text)-1]
@@ -385,9 +385,9 @@ def doc_table(self, paragraph,
             rows.append(cols)
             cols = []
         return StructuredTextTable(rows,text,subs,indent=paragraph.indent)
-            
+
 ZwikiDocumentWithImages = ZwikiDocumentWithImages()
-    
+
 registerPageType(PageTypeStx)
 
 # backwards compatibility - need this here for old zodb objects
diff --git a/plugins/pagetypes/stx_tests.py b/plugins/pagetypes/stx_tests.py
index 4f87bea..5feaab2 100644
--- a/plugins/pagetypes/stx_tests.py
+++ b/plugins/pagetypes/stx_tests.py
@@ -21,7 +21,7 @@ def test_edit(self):
     def test_non_ascii_edit(self):
         self.p.edit(text='É')
         self.assertEquals(u'
É
\n
\n
\n', self.p.render(bare=1))
-                          
+
     #def test_stxToHtml(self):
     #    p = self.page
     #    # handle a STX table or other error gracefully
diff --git a/plugins/rating/rating.py b/plugins/rating/rating.py
index c37b05d..f5dbe20 100644
--- a/plugins/rating/rating.py
+++ b/plugins/rating/rating.py
@@ -60,7 +60,7 @@ def numericVotes(self):
         return self.votes().values()
 
     # api methods
-    
+
     security.declareProtected(Permissions.Rate, 'vote')
     def vote(self,vote=None,REQUEST=None):
         """
@@ -130,11 +130,11 @@ def voteCount(self):
 
     security.declareProtected(Permissions.View, 'hasVotes')
     def hasVotes(self): return self.voteCount() > 0
-        
+
     security.declareProtected(Permissions.View, 'myVote')
     def myVote(self,REQUEST=None):
         """
-        What is the current user's recorded vote for this page ? 
+        What is the current user's recorded vote for this page ?
 
         Returns a string or None.
         """
@@ -160,13 +160,13 @@ def myVotes(self,REQUEST=None):
     security.declareProtected(Permissions.View, 'myvotes')
     def myvotes(self):
         """
-        A temporary web view for the above. 
+        A temporary web view for the above.
         """
         votes = self.myVotes()
         return '
%s
' % (
             ''.join(['%2s %s\n' % (votes[p], self.renderLinkToPage(p))
                     for p in votes.keys()]))
-        
+
     security.declareProtected(Permissions.View, 'rating')
     def rating(self):
         """
@@ -212,5 +212,5 @@ def ensureVotesIsBtree(self):
             for k,v in temp_dict.iteritems():
                 self._votes[k] = v
 
-InitializeClass(PluginRating) 
+InitializeClass(PluginRating)
 registerPlugin(PluginRating)
diff --git a/plugins/rating/ratingform.pt b/plugins/rating/ratingform.pt
index 3c6d922..3b65339 100644
--- a/plugins/rating/ratingform.pt
+++ b/plugins/rating/ratingform.pt
@@ -1,17 +1,17 @@
 
   
-    
  
+    

       
       

         
         
-        
-           = 1) and 'misc_/ZWiki/star_icon'
                                                           or 'misc_/ZWiki/blank_star_icon';
                                style python:myvotestyle('1');
                                title python:mouseovertitle('1');"
-           />= 2) and 'misc_/ZWiki/star_icon'
                                                          or 'misc_/ZWiki/blank_star_icon';
                                style python:myvotestyle('2');
                                title python:mouseovertitle('2');"
-           />= 3) and 'misc_/ZWiki/star_icon'
                                                          or 'misc_/ZWiki/blank_star_icon';
                                style python:myvotestyle('3');
                                title python:mouseovertitle('3');"
-           />= 4) and 'misc_/ZWiki/star_icon'
                                                          or 'misc_/ZWiki/blank_star_icon';
                                style python:myvotestyle('4');
                                title python:mouseovertitle('4');"
-           />= 5) and 'misc_/ZWiki/star_icon'
                                                          or 'misc_/ZWiki/blank_star_icon';
                                style python:myvotestyle('5');
                                title python:mouseovertitle('5');"
diff --git a/plugins/rss.py b/plugins/rss.py
index cbfd4e7..0546028 100644
--- a/plugins/rss.py
+++ b/plugins/rss.py
@@ -141,7 +141,7 @@ def title_quote(self, title):
         We replace only &, > and <
         this is according to RSS specs in
         http://www.rssboard.org/rss-profile#data-types-characterdata
-        Nonetheless, http://feedvalidator.org/ claims there is html in 
+        Nonetheless, http://feedvalidator.org/ claims there is html in
         those encoded titles.
         """
         title = title.replace('&', '&', -1)
@@ -152,5 +152,5 @@ def title_quote(self, title):
     # backwards compatibility
     changes_rss = edits_rss
 
-InitializeClass(PageRSSSupport) 
+InitializeClass(PageRSSSupport)
 registerPlugin(PageRSSSupport)
diff --git a/plugins/tracker/FilterIssues.dtml b/plugins/tracker/FilterIssues.dtml
index 9631eb1..0805e15 100644
--- a/plugins/tracker/FilterIssues.dtml
+++ b/plugins/tracker/FilterIssues.dtml
@@ -8,11 +8,11 @@
 
 This page looks **broken**, because it needs dtml enabled to work.
 
-You can enable dtml by setting a boolean property called allow_dtml to true 
+You can enable dtml by setting a boolean property called allow_dtml to true
 on this page.
 
-You might then want to lock this page by going to the security tab and 
-unchecking the "Zwiki:Edit pages" and "Zwiki:Add comments" permissions 
+You might then want to lock this page by going to the security tab and
+unchecking the "Zwiki:Edit pages" and "Zwiki:Add comments" permissions
 from non-manager users if you are security conscious.
 
 --------------------------------------
@@ -21,7 +21,7 @@ from non-manager users if you are security conscious.
 
 
-More advanced 
+More advanced
 
-issue tracker 
+issue tracker
 search options.
 
 

 

 
 
-
 
@@ -91,9 +91,9 @@ from non-manager users if you are security conscious.
 
-
@@ -177,7 +177,7 @@ from non-manager users if you are security conscious.
    Three cases:
    - if we have a search term, search for it in title, text and category
      (a dumb way, concatenate three searches)
-   - or, if we have a query string, search and sort according to those 
+   - or, if we have a query string, search and sort according to those
      parameters
    #- otherwise, show a default search (open issues by severity)
  
@@ -187,7 +187,7 @@ from non-manager users if you are security conscious.
    results. Try both at once I guess.
    XXX try again ?
  
- 
           60)"
 	  titleseparator="_.string.find(Title,' ')"
 	  issuenmbr="titleseparator != -1 and Title[:titleseparator] or 'None'"
@@ -288,7 +288,7 @@ from non-manager users if you are security conscious.
                
                
                ' or ''"
-               >">&dtml-issuenmbr;
                ' or ''">
              
@@ -297,7 +297,7 @@ from non-manager users if you are security conscious.
                
                
                ' or ''"
-               >">&dtml-issuenam;
                ' or ''">
              
diff --git a/plugins/tracker/IssueBrowser.dtml b/plugins/tracker/IssueBrowser.dtml
index b9f3350..f999584 100644
--- a/plugins/tracker/IssueBrowser.dtml
+++ b/plugins/tracker/IssueBrowser.dtml
@@ -7,20 +7,20 @@
 
 This page looks **broken**, because it needs dtml enabled to work.
 
-You can enable dtml by setting a boolean property called allow_dtml to true 
+You can enable dtml by setting a boolean property called allow_dtml to true
 on this page.
 
-You might then want to lock this page by going to the security tab and 
-unchecking the "Zwiki:Edit pages" and "Zwiki:Add comments" permissions 
+You might then want to lock this page by going to the security tab and
+unchecking the "Zwiki:Edit pages" and "Zwiki:Add comments" permissions
 from non-manager users if you are security conscious.
 
 --------------------------------------
 
 
 
- 
+
 
-">
         

 

 
 
 
 SELECTED
 >&dtml-x_sequence_item;
 
- 
+
 
 
 Severities:

@@ -145,7 +145,7 @@ from non-manager users if you are security conscious.
 SELECTED
 >&dtml-x_sequence_item;
 
- 
+
 		
 
 Statuses:

@@ -155,11 +155,11 @@ from non-manager users if you are security conscious.
 SELECTED
 >&dtml-x_sequence_item;
 
- 
+
 		
 

 
 
+
 
  
 

-        
@@ -100,7 +100,7 @@ issue categories sized and coloured according to open issues
 
 
 

-
-

         
  
+

     ">
       
-        
 

 [-] hide overview Open issues by category:
-">
         

   

-        
diff --git a/plugins/tracker/issuepropertiesform.dtml b/plugins/tracker/issuepropertiesform.dtml
index c8ccc95..35695fe 100644
--- a/plugins/tracker/issuepropertiesform.dtml
+++ b/plugins/tracker/issuepropertiesform.dtml
@@ -53,14 +53,14 @@ seconds="_.int(_.round((elapsed-days-hourfactor*hours-minutefactor*minutes)/seco
 
 
- 
+Severity: 
+Status: 
 

-Optional comment: