Tags:
create new tag
view all tags

Question

I am using twiki to document support proceedures. The actions that need to be followed numbered using the standard <space> <space> <space> 1. format however I would like to include example results within the instructions.

Each time I use verbatim it results in the numbering being restarted.

For Example

   1. Log onto the server
   1. Run command ==#/go/here/runthis==
<verbatim>
   # /go/here/runthis
     hello world
</verbatim>
   1.  Next command ==# /go/here/runthisnext==

looks like this

  1. Log on to the server
  2. Run command #/go/here/runthis
   # /go/here/runthis
     hello world
  1. Next command # /go/here/runthisnext

Can anybody help. Thanks

Environment

TWiki version: TWikiRelease02Sep2004
TWiki plugins: DefaultPlugin, EmptyPlugin, InterwikiPlugin
Server OS:  
Web server:  
Perl version:  
Client OS:  
Web Browser:  
Categories: Documentation

-- AndyBush - 26 Jul 2005

Answer

ALERT! If you answer a question - or someone answered one of your questions - please remember to edit the page and set the status to answered. The status selector is below the edit box.

Verbatim text in a bullet is not well supported at this time. You can solve it / work around in two ways:

1. Indent the verbatim text

  1. Log onto the server
  2. Run command #/go/here/runthis
          # /go/here/runthis
          hello world
          
  3. Next command # /go/here/runthisnext

2. Use =preformatted text= and %BR% line breaks:

  1. Log onto the server
  2. Run command #/go/here/runthis
    # /go/here/runthis
    hello world
  3. Next command # /go/here/runthisnext

(view raw text to see how)

-- PeterThoeny - 27 Jul 2005

frown The first solution doesn't work properly on Develop (the list numbering isn't continued correctly). But it should, shouldn't it?

-- FranzJosefSilli - 27 Jul 2005

Franz - are you refering to Bugs:Item145 ?

  • Now yes. wink - FJ

-- SvenDowideit - 28 Jul 2005

Use a combination of:

  1. outline format as you see to left,
  2. transparent shim of 1x20 pixel width, and
  3. tactical use of the BR tag.

The resulting output is:

  1. The bullets are numbered
    and the lines can be indented
    an arbitrary depth

  2. And the bullet numbering is consistent despite multiple displayed gaps because the BR symbols keep the source text abutted as required by the bullet-handling code.
    meanwhile the lines
    still indent as expected to the depth you desire.

It does make it a bit harder to read the source text. This would be eased if a BR-like global symbol were defined for this transparent shim. But in the meantime you have a completely workable solution.

By the way, I used it to good effect on my TWiki.

-- RichardFreytag - 28 Jul 2005

You can very easily define your own BR-like global symbol by defining one in your TWikiPreferences.

-- FranzJosefSilli - 29 Jul 2005

Topic attachments
I Attachment History Action Size Date Who Comment
GIFgif transparent_shim_1x20.gif r1 manage 0.8 K 2005-07-28 - 19:43 UnknownUser Useful transparent 1x20 pixel shim for indenting text in a bullet
Edit | Attach | Watch | Print version | History: r8 < r7 < r6 < r5 < r4 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r8 - 2005-07-29 - FranzJosefSilli
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.