Sha256: caca0e0fc7fc7af1a3c13b74fa2456667509baace3e8cde966fbfe483ba561d7

Contents?: true

Size: 903 Bytes

Versions: 6

Compression:

Stored size: 903 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

6 entries across 6 versions & 1 rubygems

Version Path
webgen-0.5.17 doc/tag/includefile.page
webgen-0.5.15 doc/tag/includefile.page
webgen-0.5.14 doc/tag/includefile.page
webgen-0.5.13 doc/tag/includefile.page
webgen-0.5.12 doc/tag/includefile.page
webgen-0.5.11 doc/tag/includefile.page