Sha256: f41072fed059c8fcbc73e6ddc42fda1dbe1e8da1fd2d83114c5ff2e6d7d40a9d

Contents?: true

Size: 899 Bytes

Versions: 16

Compression:

Stored size: 899 Bytes

Contents

---
title: Webgen::Tag::IncludeFile
used_options:
  - tag.includefile.filename
  - tag.includefile.process_output
  - tag.includefile.escape_html
---
## Description

The include file tag is used to include the content of a file. The filename needs to be specified
relative to the website directory or an absolute filename.

> By surrounding the include file tag with a syntax highlighting tag it is possible to highlight the
> contents of a file.
{.information}


## Examples

<table class="examples">
<tr>
  <th>Usage</th><th>Output</th>
</tr>
<tr>
  <td>\{include_file: {filename: AUTHORS, process_output: false}}</td>
  <% if File.exists?(File.join(context.website.directory, 'AUTHORS')) %>
  <td><pre>{include_file: {filename: AUTHORS, process_output: false}}</pre></td>
  <% else %>
  <td><pre>{include_file: {filename: ../AUTHORS, process_output: false}}</pre></td>
  <% end %>
</tr>
</table>

Version data entries

16 entries across 16 versions & 3 rubygems

Version Path
gettalong-webgen-0.5.4.20080929 doc/tag/includefile.page
gettalong-webgen-0.5.5.20081001 doc/tag/includefile.page
gettalong-webgen-0.5.5.20081010 doc/tag/includefile.page
gettalong-webgen-0.5.5.20081012 doc/tag/includefile.page
gettalong-webgen-0.5.6.20081020 doc/tag/includefile.page
gettalong-webgen-0.5.7.20090227 doc/tag/includefile.page
gettalong-webgen-0.5.8.20090507 doc/tag/includefile.page
thewoolleyman-webgen-0.5.8.20090419 doc/tag/includefile.page
webgen-0.5.1 doc/tag/includefile.page
webgen-0.5.4 doc/tag/includefile.page
webgen-0.5.2 doc/tag/includefile.page
webgen-0.5.3 doc/tag/includefile.page
webgen-0.5.5 doc/tag/includefile.page
webgen-0.5.7 doc/tag/includefile.page
webgen-0.5.6 doc/tag/includefile.page
webgen-0.5.8 doc/tag/includefile.page