Text Formatting ⇒ Labeled verbatim

[mobow]

Dear All,

I have a problem with the formatting of my document. I need a (multilined) verbatim to be labled just like an equation, so I could cross-reference it in the text. The verbatim text should be on the left and the number (like [chapternumber].[verbatimnumber]) on the right (just like an equation).

I have tried to create a new environment and creating a table with in the left column the verbatim text and in the right column the number, however I don't get this to work.

I have also looked for a different approach, like a multiline equation in verbatim style, however I couldn't find any.

edit:

I now have this

Code: Select all

Code, edit and compile here:

1
2
3
4
5
6
7
\newcounter{ruleverb}
\newenvironment{ruleverb}
    {\refstepcounter{ruleverb}
          \begin{tabular}{m{0.8\textwidth} r}}
     { & 
     Rule~\theruleverb %
     \end{tabular}}
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Run LaTeX here

However it does not take into account the margin of the text.

Thank you in advance!

[localghost]

If you could explain a little bit more concrete what you are aiming at, it would be easier to give some suggestions. From your code sample I only can see that this should be called a "Rule" but I do not yet understand what purpose is behind the verbatim part (maybe a kind of theorem or listing or something similar). You may describe the look of the final output apart from the equation like numbering.


Best regards and welcome to the board
Thorsten

[frabjous]

Perhaps this thread may provide some guidance.

[mobow]

Thank you both for your reaction. I have had a look at that page frabjous pointed to, but it was not exactly I was looking for. I think I now have something I am pretty satisfied with. One more thing is in the example I gave, how do I let the rule number be preceded by the chapter number? The final result must look something like this:

latex.jpg (21.22 KiB) Viewed 7513 times

As you can see, my little dissatisfaction is in the fact that the 5 is not fully on the right margin.

[localghost]

[…] I think I now have something I am pretty satisfied with. One more thing is in the example I gave, how do I let the rule number be preceded by the chapter number? […]

Introduce the code for this layout to make others see what has to be modified. Please upload picture attachments to the forum server.

[mobow]

Again, the code is this:

Code: Select all

Code, edit and compile here:

1
2
3
4
5
6
7
\newcounter{ruleverb}
\newenvironment{ruleverb}
    {\refstepcounter{ruleverb}
    \begin{tabular}{m{0.8\textwidth} r}}
     { & 
     Rule~\theruleverb %
     \end{tabular}}
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Run LaTeX here

To be used like this:

Code: Select all

Code, edit and compile here:

1
2
3
4
5
6
7
\begin{ruleverb}
\label{rulex}
\begin{verbatim}
private string testToken;
private int testInt;
\end{verbatim}
\end{ruleverb}
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Run LaTeX here

Result is thus:

latex.jpg (21.22 KiB) Viewed 7513 times

Sorry for not being clear the first time.

[Juanjo]

The problem with your code is that the width of the table generated by the tabular environment is lesser than \textwidth. Instead of solving that, I would suggest playing with the fancyvrb package, which allows to define custom verbatim environments. Please consider the following code:

Code: Select all

Code, edit and compile here:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
\documentclass[a4paper,12pt]{article}
\usepackage{fancyvrb,color}
\makeatletter
\newcounter{ruleverb}
\newcommand\FVB@RuleVerbatim{\refstepcounter{ruleverb}%
   \par\vspace{\abovedisplayskip}\noindent%
   \FV@BVerbatimBegin\FV@Scan}
   
\newcommand\FVE@RuleVerbatim{\FV@BVerbatimEnd\hfill[Rule~\theruleverb]%
   \par\vspace{\belowdisplayskip}}
   
\DefineVerbatimEnvironment{RuleVerbatim}{RuleVerbatim}{baseline=c}
\define@key{FV}{reflabel}{%
   \def\@tempa{#1}\ifx\@tempa\empty\relax\else\label{#1}\fi}
   
\makeatother
\begin{document}
This is some text that precedes the numbered verbatim text that I'd like to use
\begin{RuleVerbatim}
private string testToken;
private int testInt;
other line of code;
and another one
\end{RuleVerbatim}
This text is just following some rule text to fill in the margins and stuff.
Bla bla bla bla
This is some text that precedes the numbered verbatim text that I'd like to use
\begin{RuleVerbatim}[gobble=5]
     private string testToken;
     private int testInt;
     other line of code;
     and another one
\end{RuleVerbatim}
This text is just following some rule text to fill in the margins and stuff.
 
 
הההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההההה
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Run LaTeX here

The RuleVerbatim environment works as any other one defined in fancyvrb. Read the package manual. However, since RuleVerbatim is based on BVerbatim (cf. subsection 4.2 of the manual) some parameters does not work (frame, numbers...). Likewise, to cite some instance of RuleVerbatim, use the new parameter reflabel (defined in the preamble of the above code). Finally, the space above and below the environment is that of a usual displayed equation (\abovedisplayskip and \belowdisplayskip).

I hope the code may help.

[mobow]

Thank you! That was pretty much what I was looking for!

The only sad thing is that my editor (TeXlipse) does not like the verbatim that is not 'really' within a verbatim environment (e.g., does not start and end with verbatim). So all following text is no longer correctly colored. But I guess I have to live with it.