[Python-checkins] python/dist/src/Doc/doc doc.tex,1.79,1.80

[fdrake at users.sourceforge.net]

Update of /cvsroot/python/python/dist/src/Doc/doc
In directory sc8-pr-cvs1:/tmp/cvs-serv12448/doc

Modified Files:
	doc.tex 
Log Message:
add new reference macro: \seelink

Index: doc.tex
===================================================================
RCS file: /cvsroot/python/python/dist/src/Doc/doc/doc.tex,v
retrieving revision 1.79
retrieving revision 1.80
diff -C2 -d -r1.79 -r1.80
*** doc.tex	11 Oct 2003 05:25:24 -0000	1.79
--- doc.tex	8 Jan 2004 14:57:27 -0000	1.80
***************
*** 1396,1403 ****
      complete sentences, starting with a capital letter (unless it
      starts with an identifier, which should not be modified), and
!     ending with the apropriate punctuation.
  
      These macros are only defined within the content of the
      \env{seealso} and \env{seealso*} environments.
  
      \begin{macrodesc}{seemodule}{\op{key}\p{name}\p{why}}
--- 1396,1412 ----
      complete sentences, starting with a capital letter (unless it
      starts with an identifier, which should not be modified), and
!     ending with the appropriate punctuation.
  
      These macros are only defined within the content of the
      \env{seealso} and \env{seealso*} environments.
+ 
+     \begin{macrodesc}{seelink}{\p{url}\p{linktext}\p{why}}
+       References to specific on-line resources should be given using
+       the \macro{seelink} macro if they don't have a meaningful title
+       but there is some short description of what's at the end of the
+       link.  Online documents which have identifiable titles should be
+       referenced using the \macro{seetitle} macro, using the optional
+       parameter to that macro to provide the URL.
+     \end{macrodesc}
  
      \begin{macrodesc}{seemodule}{\op{key}\p{name}\p{why}}