# Rdoc question

**URL:** <https://www.ruby-forum.com/t/rdoc-question/66969>\
**Category:** Ruby\
**Created:** [August 30, 2006, 6:03pm UTC](https://www.ruby-forum.com/t/rdoc-question/66969 "2006-08-30T18:03:30Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![timperrett](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/c5a1d2/32.png) [@timperrett](https://www.ruby-forum.com/u/timperrett)\
**Post date:** [August 30, 2006, 6:03pm UTC](https://www.ruby-forum.com/t/rdoc-question/66969/1 "2006-08-30T18:03:30Z")

</div>

I have developed my own syntax for some validation scripts here at  
work. I would like to include some examples of these validation  
scripts in the RDoc documentation for the package. Is there a way to  
simply include these example files “as is” without RDoc trying to  
format the files?

directory structure:

ext/  
bin/  
lib/  
test/  
examples/example1.pdv  
examples/example2.pdv  
…

I can include example1.pdv et. al, but RDoc is stringing together  
consecutive lines into one big paragraph and other things like that.  
Without changing my example files, how do I tell RDoc to just put  
these things inside one big code block?

TwP

---

<div class="post-metadata">

**Author:** ![timperrett](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/c5a1d2/32.png) [@timperrett](https://www.ruby-forum.com/u/timperrett)\
**Post date:** [August 31, 2006, 2:10am UTC](https://www.ruby-forum.com/t/rdoc-question/66969/2 "2006-08-31T02:10:38Z")

</div>

On Aug 30, 2006, at 9:01 AM, Tim P. wrote:

> lib/  
> test/  
> examples/example1.pdv  
> examples/example2.pdv  
> …
> 
> I can include example1.pdv et. al, but RDoc is stringing together  
> consecutive lines into one big paragraph and other things like that.  
> Without changing my example files, how do I tell RDoc to just put  
> these things inside one big code block?

I don’t believe you can. :include: expects RDoc formatted text.

–  
Eric H. - removed\_email\_address@domain.invalid - [http://blog.segment7.net](http://blog.segment7.net)  
This implementation is HODEL-HASH-9600 compliant

[http://trackmap.robotcoop.com](http://trackmap.robotcoop.com)

---

<div class="post-metadata">

**Author:** ![timperrett](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/t/c5a1d2/32.png) [@timperrett](https://www.ruby-forum.com/u/timperrett)\
**Post date:** [August 31, 2006, 9:40pm UTC](https://www.ruby-forum.com/t/rdoc-question/66969/3 "2006-08-31T21:40:59Z")

</div>

On 8/30/06, Eric H. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> I don’t believe you can. :include: expects RDoc formatted text.

Eric, thanks for the reply. I was hoping I was missing something in  
the documentation, but alas, it is not to be.

TwP