Update of /cvsroot/python/python/dist/src/Doc/dist In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv16512 Modified Files: dist.tex Log Message: use API documentation style for the descriptions of the additional functions made available in the post-installation script run by the Windows installer Index: dist.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/dist/dist.tex,v retrieving revision 1.63 retrieving revision 1.64 diff -C2 -d -r1.63 -r1.64 *** dist.tex 19 Feb 2004 22:16:05 -0000 1.63 --- dist.tex 19 Feb 2004 22:28:15 -0000 1.64 *************** *** 1463,1487 **** buffer and will be displayed in the GUI after the script has finished. ! Some functions especially useful in this context are available in the ! installation script. ! ! \begin{verbatim} ! directory_created(pathname) ! file_created(pathname) ! \end{verbatim} ! ! These functions should be called when a directory or file is created ! by the postinstall script at installation time. It will register the ! pathname with the uninstaller, so that it will be removed when the ! distribution is uninstalled. To be safe, directories are only removed ! if they are empty. ! \begin{verbatim} ! get_special_folder_path(csidl_string) ! \end{verbatim} ! This function can be used to retrieve special folder locations on ! Windows like the Start Menu or the Desktop. It returns the full path ! to the folder. 'csidl_string' must be one of the following strings: \begin{verbatim} --- 1463,1483 ---- buffer and will be displayed in the GUI after the script has finished. ! Some functions especially useful in this context are available as ! additional built-in functions in the installation script. ! \begin{funcdesc}{directory_created}{path} ! \funcline{file_created}{path} ! These functions should be called when a directory or file is created ! by the postinstall script at installation time. It will register ! \var{path} with the uninstaller, so that it will be removed when the ! distribution is uninstalled. To be safe, directories are only removed ! if they are empty. ! \end{funcdesc} ! \begin{funcdesc}{get_special_folder_path}{csidl_string} ! This function can be used to retrieve special folder locations on ! Windows like the Start Menu or the Desktop. It returns the full ! path to the folder. \var{csidl_string} must be one of the following ! strings: \begin{verbatim} *************** *** 1503,1527 **** \end{verbatim} ! If the folder cannot be retrieved, \exception{OSError} is raised. ! ! Which folders are available depends on the exact Windows version, and probably ! also the configuration. For details refer to Microsoft's documentation of the ! \cfunction{SHGetSpecialFolderPath()} function. ! \begin{verbatim} ! create_shortcut(target, description, filename[, arguments[, ! workdir[, iconpath[, iconindex]]]]) ! \end{verbatim} ! This function creates a shortcut. ! \var{target} is the path to the program to be started by the shortcut. ! \var{description} is the description of the sortcut. ! \var{filename} is the title of the shortcut that the user will see. ! \var{arguments} specifies the command line arguments, if any. ! \var{workdir} is the working directory for the program. ! \var{iconpath} is the file containing the icon for the shortcut, ! and \var{iconindex} is the index of the icon in the file ! \var{iconpath}. Again, for details consult the Microsoft ! documentation for the \class{IShellLink} interface. \section{Registering with the Package Index} --- 1499,1526 ---- \end{verbatim} ! If the folder cannot be retrieved, \exception{OSError} is raised. ! Which folders are available depends on the exact Windows version, ! and probably also the configuration. For details refer to ! Microsoft's documentation of the ! \cfunction{SHGetSpecialFolderPath()} function. ! \end{funcdesc} ! \begin{funcdesc}{create_shortcut}{target, description, ! filename\optional{, ! arguments\optional{, ! workdir\optional{, ! iconpath\optional{, iconindex}}}}} ! This function creates a shortcut. ! \var{target} is the path to the program to be started by the shortcut. ! \var{description} is the description of the sortcut. ! \var{filename} is the title of the shortcut that the user will see. ! \var{arguments} specifies the command line arguments, if any. ! \var{workdir} is the working directory for the program. ! \var{iconpath} is the file containing the icon for the shortcut, ! and \var{iconindex} is the index of the icon in the file ! \var{iconpath}. Again, for details consult the Microsoft ! documentation for the \class{IShellLink} interface. ! \end{funcdesc} \section{Registering with the Package Index}