summaryrefslogtreecommitdiffstats
path: root/Tools/idle/help.txt
diff options
context:
space:
mode:
authorGuido van Rossum <guido@python.org>1998-10-10 18:48:31 (GMT)
committerGuido van Rossum <guido@python.org>1998-10-10 18:48:31 (GMT)
commit3b4ca0ddad8d1e224f71e89f4c7fbc8de5c6edc4 (patch)
tree1a66ed7c7eec87f31d61a2a083096e5cad89a39c /Tools/idle/help.txt
parentdc1adabcb86ee0813c9bae2d5cc59be5cad1ff31 (diff)
downloadcpython-3b4ca0ddad8d1e224f71e89f4c7fbc8de5c6edc4.zip
cpython-3b4ca0ddad8d1e224f71e89f4c7fbc8de5c6edc4.tar.gz
cpython-3b4ca0ddad8d1e224f71e89f4c7fbc8de5c6edc4.tar.bz2
Initial checking of Tk-based Python IDE.
Features: text editor with syntax coloring and undo; subclassed into interactive Python shell which adds history.
Diffstat (limited to 'Tools/idle/help.txt')
-rw-r--r--Tools/idle/help.txt60
1 files changed, 60 insertions, 0 deletions
diff --git a/Tools/idle/help.txt b/Tools/idle/help.txt
new file mode 100644
index 0000000..6dbf2fa
--- /dev/null
+++ b/Tools/idle/help.txt
@@ -0,0 +1,60 @@
+Windows and files:
+
+ ^X ^N creates new empty text editor window
+ ^X ^C closes all windows
+ Alt-F4 or ^X ^0 (that's control-x-control-zero) closes current window
+ ^X ^D opens a file from dialog box
+ ^X ^S saves to current file
+ ^X ^W saves to file from dialog box
+ ^X w save a copy to file from dialog box
+
+Navigation:
+
+ Arrow keys and Page Up/Down to move around
+ Home/End go to begin/end of line
+ Control-Home/End go to begin/end of file
+ Some Emacs bindings may also work, e.g. ^A/^E
+
+Searching: all searches are forward from the cursor without
+wrap-around, case sensitive, Perl-style regular expression matches
+
+ ^S without a selection opens search dialog box
+ ^S with a selection searches for selected text
+ ^U ^S repeats last search
+ Alt-G opens dialog box to go to a specific line
+
+Editing:
+
+ Backspace deletes left of cursor, Delete right of cursor
+ Cut and paste use platform's conventions
+ ^[ or Alt-[ left-shifts (dedents) the current line or selection
+ ^] or Alt-] right-shifts (indents) the current line or selection
+ Alt-/ expands last word you type (like Emacs dabbrev)
+
+Undo:
+
+ ^Z undoes last change; repeat to undo more
+ Alt-Z redoes last undone change; repeat to redo more
+
+Console window:
+
+ ^C interrupts executing command
+ ^D sends end-of-file; closes console if typed at >>> prompt
+
+ If you get a traceback, right-click on any line listing a
+ filename and line number and select "Go to line from
+ traceback" to open that file and go to the indicated line
+
+Python syntax colors: the coloring is applied in a background thread
+
+ Keywords orange
+ Strings green
+ Comments red
+ Definitions blue
+
+Console colors:
+
+ Console output red
+ stdout blue
+ stderr dark green
+ stdin purple
@@ CASE_SENSE_NAMES = NO IMAGE_PATH = . INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \ grouping.doc formulas.doc diagrams.doc preprocessing.doc \ - autolink.doc output.doc custcmd.doc external.doc faq.doc trouble.doc history.doc features.doc \ + autolink.doc output.doc customize.doc custcmd.doc external.doc faq.doc trouble.doc history.doc features.doc \ doxygen_usage.doc doxytag_usage.doc \ doxywizard_usage.doc installdox_usage.doc \ config.doc commands.doc htmlcmds.doc xmlcmds.doc language.doc \ diff --git a/doc/config.doc b/doc/config.doc index 31ff5a4..27fde41 100644 --- a/doc/config.doc +++ b/doc/config.doc @@ -58,7 +58,6 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_abbreviate_brief ABBREVIATE_BRIEF \refitem cfg_aliases ALIASES \refitem cfg_allexternals ALLEXTERNALS -\refitem cfg_alphabetical_index ALPHABETICAL_INDEX \refitem cfg_always_detailed_sec ALWAYS_DETAILED_SEC \refitem cfg_binary_toc BINARY_TOC \refitem cfg_builtin_stl_support BUILTIN_STL_SUPPORT @@ -68,14 +67,11 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_case_sense_names CASE_SENSE_NAMES \refitem cfg_chm_file CHM_FILE \refitem cfg_class_diagrams CLASS_DIAGRAMS -\refitem cfg_class_graph CLASS_GRAPH -\refitem cfg_collaboration_graph COLLABORATION_GRAPH \refitem cfg_cols_in_alpha_index COLS_IN_ALPHA_INDEX \refitem cfg_compact_latex COMPACT_LATEX \refitem cfg_compact_rtf COMPACT_RTF \refitem cfg_cpp_cli_support CPP_CLI_SUPPORT \refitem cfg_create_subdirs CREATE_SUBDIRS -\refitem cfg_details_at_top DETAILS_AT_TOP \refitem cfg_directory_graph DIRECTORY_GRAPH \refitem cfg_disable_index DISABLE_INDEX \refitem cfg_distribute_group_doc DISTRIBUTE_GROUP_DOC @@ -134,7 +130,6 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_generate_treeview GENERATE_TREEVIEW \refitem cfg_generate_xml GENERATE_XML \refitem cfg_graphical_hierarchy GRAPHICAL_HIERARCHY -\refitem cfg_group_graphs GROUP_GRAPHS \refitem cfg_have_dot HAVE_DOT \refitem cfg_hhc_location HHC_LOCATION \refitem cfg_hide_friend_compounds HIDE_FRIEND_COMPOUNDS @@ -152,7 +147,6 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_idl_property_support IDL_PROPERTY_SUPPORT \refitem cfg_ignore_prefix IGNORE_PREFIX \refitem cfg_image_path IMAGE_PATH -\refitem cfg_include_graph INCLUDE_GRAPH \refitem cfg_include_path INCLUDE_PATH \refitem cfg_inherit_docs INHERIT_DOCS \refitem cfg_inline_info INLINE_INFO @@ -168,6 +162,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_latex_header LATEX_HEADER \refitem cfg_latex_hide_indices LATEX_HIDE_INDICES \refitem cfg_latex_output LATEX_OUTPUT +\refitem cfg_layout_file LAYOUT_FILE \refitem cfg_macro_expansion MACRO_EXPANSION \refitem cfg_makeindex_cmd_name MAKEINDEX_CMD_NAME \refitem cfg_man_extension MAN_EXTENSION @@ -211,9 +206,7 @@ followed by the descriptions of the tags grouped by category. \refitem cfg_short_names SHORT_NAMES \refitem cfg_show_dirs SHOW_DIRECTORIES \refitem cfg_show_files SHOW_FILES -\refitem cfg_show_include_files SHOW_INCLUDE_FILES \refitem cfg_show_namespaces SHOW_NAMESPACES -\refitem cfg_show_used_files SHOW_USED_FILES \refitem cfg_sip_support SIP_SUPPORT \refitem cfg_skip_function_macros SKIP_FUNCTION_MACROS \refitem cfg_sort_brief_docs SORT_BRIEF_DOCS @@ -480,6 +473,7 @@ followed by the descriptions of the tags grouped by category. Note that setting this tag to YES also means that rational rose comments are not recognized any more. + \anchor cfg_inherit_docs
\c INHERIT_DOCS
@@ -692,12 +687,14 @@ function's detailed documentation block. will show members with their full class and namespace scopes in the documentation. If set to \c YES the scope will be hidden. + \anchor cfg_inline_info
\c INLINE_INFO
@@ -789,12 +786,14 @@ function's detailed documentation block. individual variables and defines can be controlled using \ref cmdshowinitializer "\\showinitializer" or \ref cmdhideinitializer "\\hideinitializer" command in the documentation. + \anchor cfg_show_dirs
\c SHOW_DIRECTORIES
@@ -949,6 +948,17 @@ Example filter for ClearCase: FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \endverbatim +\anchor cfg_layout_file +
\c LAYOUT_FILE
+ The \c LAYOUT_FILE tag can be used to specify a layout file which will be parsed by + doxygen. The layout file controls the global structure of the generated output files + in an output format independent way. The create the layout file that represents + doxygen's defaults, run doxygen with the -l option. You can optionally specify a + file name after the option, if omitted doxygenlayout.xml will be used as the name + of the layout file. Note that if you run doxygen from a directory containing + a file called doxygenlayout.xml, doxygen will parse it automatically even if + the \c LAYOUT_FILE tag is left empty. + \anchor cfg_recursive
\c RECURSIVE
\addindex RECURSIVE @@ -1124,14 +1134,16 @@ FILE_VERSION_INFO = "cleartool desc -fmt \%Vn" \anchor cfg_alphabetical_index
+ -\anchor cfg_cols_in_alpha_index
\c COLS_IN_ALPHA_INDEX
+ \anchor cfg_cols_in_alpha_index \addindex COLS_IN_ALPHA_INDEX If the alphabetical index is enabled (see \c ALPHABETICAL_INDEX) then the \c COLS_IN_ALPHA_INDEX tag can be @@ -1925,6 +1937,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... different font using \c DOT_FONTNAME you can set the path where dot can find it using this tag. + \anchor cfg_uml_look
\c UML_LOOK
@@ -1967,6 +1981,7 @@ TAGFILES = file1=loc1 "file2 = loc2" ... inheritance and usage relations if the target is undocumented or is not a class. + \anchor cfg_call_graph
\c CALL_GRAPH
@@ -2060,10 +2076,11 @@ TAGFILES = file1=loc1 "file2 = loc2" ... \anchor cfg_dot_transparent
\c DOT_TRANSPARENT
\addindex DOT_TRANSPARENT - Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent - background. This is enabled by default, which results in a transparent 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). + Set the \c DOT_TRANSPARENT tag to \c YES to generate images with a transparent + background. This is disabled by default, because dot on Windows does not + seem to support this out of the box. 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). \anchor cfg_dot_multi_targets
\c DOT_MULTI_TARGETS
diff --git a/doc/customize.doc b/doc/customize.doc new file mode 100644 index 0000000..e8bc99a --- /dev/null +++ b/doc/customize.doc @@ -0,0 +1,248 @@ +/****************************************************************************** + * + * + * + * Copyright (C) 1997-2008 by Dimitri van Heesch. + * + * Permission to use, copy, modify, and distribute this software and its + * documentation under the terms of the GNU General Public License is hereby + * granted. No representations are made about the suitability of this software + * for any purpose. It is provided "as is" without express or implied warranty. + * See the GNU General Public License for more details. + * + * Documents produced by Doxygen are derivative works derived from the + * input used in their production; they are not affected by this license. + * + */ +/*! \page customize Customizing the output + +Doxygen provides various levels of customization. +The \ref minor_tweaks "first section" discusses what to +do if you want to do minor tweaker to the look and feel of the output. +The \ref layout "next" section show how to reorder and hide certain +information on a page. +The \ref xmlgenerator "last" section show how to generate whatever output +you want based on the XML output produced by doxygen. + +\section minor_tweaks Minor Tweaks + +To simply tweak things like fonts or colors, margins, or other look \& feel +espects of the HTML output you can create a different +cascading style sheet. +You can also let doxygen use a custom header and footer for each HTML +page it generates, for instance to include a logo or to make the +doxygen output blend in with the rest of the web site. + +To do this first run doxygen as follows: +\verbatim +doxygen -w html header.html footer.html customdoxygen.css +\endverbatim + +This will create 3 files: +- header.html is a HTML fragment which doxygen normally uses to start + a HTML page. Note that the fragment ends with a body tag and that is + contains a couple of commands of the form \$word. These will be replaced + by doxygen on the fly. +- footer.html is a HTML fragment which doxygen normally uses to end + a HTML page. Also here special commands can be used. This file contain the + link to www.doxygen.org and the body and html end tags. +- customdoxygen.css is the default cascading style sheet + used by doxygen. + +You should edit these files and then reference them from the config file. +\verbatim +HTML_HEADER = header.html +HTML_FOOTER = footer.html +HTML_STYLESHEET = customdoxygen.css +\endverbatim + +See the documentation of the \ref cfg_html_header "HTML_HEADER" tag +for more information about the possible meta commands. + +\note You should not put the style sheet in the HTML output directory. Treat +it is a source file. Doxygen will copy it for you. + +\note If you use images or other external content in a custom header you +need to make sure these end up in the HTML output directory yourself, +for instance by writing a script that runs doxygen can then copies the +images to the output. + + +\section layout Changing the layout of pages + +In some cases you may want to change the way the output is structured. +A different style sheet or custom headers and footers do not help in such +case. + +The solution doxygen provides is a layout file, which you can +modify and doxygen will use to control what information is presented, +in which order, and to some extent also how information is presented. +The layout file is an XML file. + +The default layout can be generated +by doxygen using the following command: +\verbatim +doxygen -l +\endverbatim +optionally the name of the layout file can be specified, if omitted +\c doxygenlayout.xml will be used. + +The toplevel structure of the file looks as follows: +\verbatim + + + ... + + + ... + + + ... + + + ... + + + ... + + + ... + + +\endverbatim + +The root tag of the XML is \c doxygenlayout, it has an attribute named +\c version, which will be used in the future to cope with changes that are +not backward compatible. + +The first section, enclosed by \c navindex tags represents the layout of +the navigation tabs displayed at the top of each HTML page. +Each tab is represented by a \c tab tag in the XML file. + +You can hide tabs by setting the \c visible attribute to \c no. +You can also override the default title of a tab by specifying it as +the value of the \c title attribute. If the title field is the empty string +(the default) then doxygen will fill in an appropriate title. +You can reorder the tabs by moving the tab tags in the XML file +within the \c navindex section and even change the tree structure. +Do not change the value of the \c type attribute however. +Only a fixed set of types are supported, each representing a link to a +specific index. + +The sections after \c navindex represent the layout of the different +pages generated by doxygen: +- The \c class section represents the layout of all pages generated for + documented classes, structs, unions, and interfaces. +- The \c namespace section represents the layout of all pages generated for + documented namespaces (and also Java packages). +- The \c file section represents the layout of all pages generated for + documented files. +- The \c group section represents the layout of all pages generated for + documented groups (or modules). +- The \c directory section represents the layout of all pages generated for + documented directories. + +Each XML tag within one of the above page sections represents a certain +piece of information. Some pieces can appear in each type of page, +others are specific for a certain type of page. +Doxygen will list the pieces in the order in which they appear +in the XML file. + +Some tags have a \c visible attribute which can be +used to hide the fragment from the generated output. +Note that the \c visible attribute is just a hint for doxygen. +If no relevant information is available for a certain piece it is +omitted even if it is set to \c yes. + +Some tags have a \c title attribute. This attribute can be used +to customize the title doxygen will use as a header for the piece. + +@warning at the moment you should not remove tags from the layout file +as a way to hide information. Doing so can cause broken links in the +generated output! + +At the moment the following generic tags are possible for each page: +
+
\c briefdescription +
Represents the brief description on a page. +
\c detaileddescription +
Represents the detailed description on a page. +
\c authorsection +
Represents the author section of a page (only used for man pages). +
\c memberdecl +
Represents the quick overview of members on a page (member declarations). + This tag has child tags each representing a list of + members of a certain type. + The possible child tags are not listed in detail in the document, + but the name of the tag should be a good indication of the type + of members that the tag represents. +
\c memberdef +
Represents the detailed member list on a page (member definition). + Like the \c memberdecl tag, also this tag has a number of + possible child tags. +
+ +The class page has the following specific tags: +
+
\c includes +
Represents the include file needed to obtain the definition for + this class. +
\c inheritancegraph +
Represents the inheritance relations for a class. + Note that the CLASS_DIAGRAM option determines + if the inheritance relation is a list of base and derived classes or + a graph. +
\c collaborationgraph +
Represents the collaboration graph for a class. +
\c allmemberslink +
Represents the link to the list of all members for a class. +
\c usedfiles +
Represents the list of files from which documentation for the class was + extracted. +
+ +The file page has the following specific tags: +
+
\c includes +
Represents the list of \#include statements contained in this file. +
\c includegraph +
Represents the include dependency graph for the file. +
\c includedbygraph +
Represents the included by dependency graph for the file. +
\c sourcelink +
Represents the link to the source code of this file. +
+ +The group page has a specific \c groupgraph tag which represents the +graph showing the dependencies between groups. + +Similarily, the directory page has a specific \c directorygraph tag +which represents the graph showing the dependencies between the directories +based on the \#include relations of the files inside the directories. + +\section xmlgenerator Using the XML output + +If the above two methods still do not provide enough flexibility, you +can also use the XML output produced by doxygen as a basis to +generate the output you like. To do this set GENERATE_XML to YES. + +The XML output consists of an index file named \c index.xml which +lists all items extracted by doxygen with references to the other XML files +for details. The structure of the index is described by a schema file +\c index.xsd. All other XML files are described by the schema file +named \c compound.xsd. If you prefer one big XML file +you can combine the index and the other files using the +XSLT file \c combine.xslt. + +You can use any XML parser to parse the file or use the one that can be found +in the \c addon/doxmlparser directory of doxygen source distribution. +Look at \c addon/doxmlparser/include/doxmlintf.h for the interface of the +parser and in \c addon/doxmlparser/example for examples. + +The advantage of using the doxmlparser is that it +will only read the index file into memory and then only those XML +files that you implicitly load via navigating through the index. As a +result this works even for very large projects where reading all XML +files as one big DOM tree would not fit into memory. + + */ diff --git a/doc/diagrams.doc b/doc/diagrams.doc index f060bd9..9295360 100644 --- a/doc/diagrams.doc +++ b/doc/diagrams.doc @@ -19,33 +19,31 @@ Doxygen has built-in support to generate inheritance diagrams for C++ classes. - Doxygen can use the "dot" tool from graphviz 1.5 to generate - more advanced diagrams and graphs. Graphviz is an "open-sourced", + Doxygen can use the "dot" tool from graphviz to generate + more advanced diagrams and graphs. Graphviz is an open-source, cross-platform graph drawing toolkit and can be found at http://www.graphviz.org/ - If you have the "dot" tool available in the path, you can set + If you have the "dot" tool in the path, you can set \ref cfg_have_dot "HAVE_DOT" to \c YES in the configuration file to let doxygen use it. Doxygen uses the "dot" tool to generate the following graphs:
    -
  • if \ref cfg_graphical_hierarchy "GRAPHICAL_HIERARCHY" is set to \c YES, - a graphical representation of the class hierarchy will be drawn, along +
  • A graphical representation of the class hierarchy will be drawn, along with the textual one. Currently this feature is supported for HTML only.\n Warning: When you have a very large class hierarchy where many classes derive from a common base class, the resulting image may become too big to handle for some browsers. -
  • if \ref cfg_class_graph "CLASS_GRAPH" is set to \c YES, - a graph will be generated for each documented class showing the +
  • An inheritance graph will be generated for each documented class showing the direct and indirect inheritance relations. This disables the generation of the built-in class inheritance diagrams. -
  • if \ref cfg_include_graph "INCLUDE_GRAPH" is set to \c YES, an include - dependency graph is generated for each documented file that includes at - least one other file. This feature is currently supported for HTML and RTF - only. -
  • if \ref cfg_collaboration_graph "COLLABORATION_GRAPH" is set to YES, a - graph is drawn for each documented class and struct that shows: +
  • An include dependency graph is generated for each documented file that + includes at least one other file. This feature is currently supported + for HTML and RTF only. +
  • An inverse include dependency graph is also generated showing for + a (header) file, which other files include it. +