Sha256: dea54c03bc56143f8cc62ba11abc6f7e0eae579a9d3f0b4d0d90ad648ce0ba47

Contents?: true

Size: 902 Bytes

Versions: 4

Compression:

Stored size: 902 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 as 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

4 entries across 4 versions & 2 rubygems

Version Path
gettalong-webgen-0.5.9.20090620 doc/tag/includefile.page
gettalong-webgen-0.5.9.20090626 doc/tag/includefile.page
webgen-0.5.10 doc/tag/includefile.page
webgen-0.5.9 doc/tag/includefile.page