RtfContrib < Extensions

You are here: Foswiki>Extensions Web>RtfContrib (revision 3) (raw view)

<!--
This topic is part of the documentation for RtfContrib and is
automatically generated from Subversion. Do not edit it! Your edits
will be lost the next time the topic is uploaded!

If you want to report an error in the topic, please raise a report at
http://foswiki.org/Tasks/RtfContrib
-->
---+!! RtfContrib
<!--
   * Set SHORTDESCRIPTION = Extension to translate Foswiki markup to RTF
-->
%SHORTDESCRIPTION%

%TOC%

---++ Usage
The current use is restricted to exporting wiki content from a topic and insert it
into a RTF template file. This template file contains tags like
=%<nop>FORMFIELD{"FirstName"}%= and =%<nop>TEXT%= which are replaced with the data extracted from 
the current topic. When you call the =rtf= CGI script on a topic like this
<verbatim>
http://your.domain.com/cgi-bin/foswiki/rtf/Main/TestUser?template=Main.UserForm.user-form.rtf&filename=Hello.rtf
</verbatim>
the script will use the RTF template =user-form.rtf= attached to the topic =Main.UserForm=
and process it as outlined. The result is then cached in a configurable =CacheDir= under the
name =Hello.rtf= in addition to sending it to the browser. Your browser can be configured to open up
the received file with an appropriate word processing tool.

---++ Template tags
The following tags are replaced with data drawn from a topic 
| *Name* | *Description* |
| =%<nop>TEXT%= | topic text |
| =%<nop>SECTION{"name"}%= | named topic section |
| =%<nop>FORMFIELD{"name"}%= | formfield of an attched <nop>DataForm |
| =%<nop>ATTACHMENT{"name" format="..."}%= | information about attached files |
| =%<nop>IMAGE{"url"}%= | inserts an image downloaded from the given url; \
  supported image formats are jpeg, png, ... |

---++ Customizing RTF output
The basic layout of the RTF output is specified by an RTF file that serves as a template.
So you have the freedom to create such a document as you like. This extension comes with
a few predefined templates that might help you to adjust them to you own needs.

In addition there are some preference variables that determine the formatting of output
generate while translating Foswiki markup to RTF.

   * headings: ...
   * lists: ...
   * ...

---++ Configuration
   * =$Foswiki::cfg{RtfContrib}{Debug}=:
     debugging flag, defaults to =0=
   * =$Foswiki::cfg{RtfContrib}{CacheDir}=:
     directory where generated RTF files are cached, defaults to %PUBURLPATH%/%SYSTEMWEB%/%TOPIC%
   * =$Foswiki::cfg{RtfContrib}{DefaultRtfTemplate}=:
     RTF file used as a template to create the final RTF file from it when exporting a topic,
     this can be overriden using the =template= urlparam on the =rtf= CGI call

---++ Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server.

Open configure, and open the "Extensions" section. Use "Find More Extensions" to get a list of available extensions. Select "Install".

If you have any problems, or if the extension isn't available in =configure=, then you can still install manually from the command-line. See http://foswiki.org/Support/ManuallyInstallingExtensions for more help.


---++ Plugin Info

|  Plugin Author(s): | Foswiki:Main/MichaelDaum |
|  Copyright: | &copy; 2007-2010 Michael Daum http://michaeldaumconsulting.com |
|  License: | [[http://www.gnu.org/licenses/gpl.html][GPL (Gnu General Public License)]] |
|  Release: | v2.00 |
|  Version: | 5566 (2009-11-17) |
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
|  12 Feb 2010: | language support in RTF templates |
|  Dependencies: | <table class="foswikiTable" border="1"><tr><th>Name</th><th>Version</th><th>Description</th></tr><tr><td align="left">Foswiki::Plugins::DBCachePlugin</td><td align="left">&gt;=1.52</td><td align="left">Required; download from Foswiki:Extensions/DBCachePlugin </td></tr></table> |
|  Plugin Home: | Foswiki:Extensions/RtfContrib |
|  Support: | Foswiki:Support/RtfContrib |

<!-- Do _not_ attempt to edit this topic; it is auto-generated. Please add comments/questions/remarks to the Dev topic instead. -->

PackageForm edit

ExtensionClassification	Exporting, Printing and Publishing
ExtensionType	PluginPackage
Compatibility
DemoUrl	http://michaeldaumconsulting.com
SupportUrl	RtfContrib
DevelopedInSVN	Yes
ModificationPolicy	CoordinateWithAuthor

Topic attachments
I	Attachment	Action	Size	Date	Who
md5	RtfContrib.md5	manage	0.1 K	12 Feb 2010 - 19:13	MichaelDaum
sha1	RtfContrib.sha1	manage	0.2 K	12 Feb 2010 - 19:13	MichaelDaum
tgz	RtfContrib.tgz	manage	12.9 K	12 Feb 2010 - 19:13	MichaelDaum
zip	RtfContrib.zip	manage	18.1 K	12 Feb 2010 - 19:13	MichaelDaum
EXT	RtfContrib_installer	manage	4.3 K	12 Feb 2010 - 19:13	MichaelDaum

Topic revision: r3 - 12 Feb 2010, MichaelDaum

Extensions

Quick Links

Tools

The copyright of the content on this website is held by the contributing authors, except where stated elsewhere. see CopyrightStatement.