What is a traceback ?

When reporting a problem in the IssueTracker, on GeneralDiscussion or on any zope-related mailing list, it's a good idea to include detailed information so people can help you. Four important things are your zwiki version, your zope version, your platform (unix, windows, mac.. ?) and most important, the error traceback. The traceback tells us what was happening when the error occurred.

Where to find it ?

When you are browsing and get a zope error, the traceback will sometimes be right there on the page (if the server is running in debug mode). Or it may be hidden in the HTML source (use your browser's View Source option to see it). With Zope 2.6 and greater, it will be accessible in the /error_log object in the ZMI. You can also configure the error_log so that tracebacks appear in the EventLog.
Occasionally it will not
be available.

Which parts to copy ?

Select the lines beginning "Traceback: ..." down to the next blank line. With zope 2.6 and greater, this is sufficient. With older zope versions, you should also copy the two lines which describe the error type and error value, which appear elsewhere on the page. Everything else is probably standard zope error text; remove it for clarity.

How to format it on the wiki ?

On zwiki.org, use StructuredText's :: quoting mechanism to format tracebacks. Typically you paste in the traceback; add a second colon to the "Traceback..." line; insert a blank line after that; and indent the last line of the traceback (all the others will be indented already). So your source text will look something like this:

Traceback::

  blah blah
  'stx formatting characters ignored'
  <dtml-var ignored>
  etc.

and will render like this:

Traceback:

blah blah
'stx formatting characters ignored'
<dtml-var ignored>
etc.

Feedback

If this document is unclear, please report it here (or fix it).