[[PageOutline(2-5,Contents,pullout)]]

= Add Fountain / Scrippets markup to wiki pages

== Description

This plugin is an implementation of [https://www.fountain.io/ Fountain] as a processor for Trac. Fountain was previously known as [http://scrippets.org Scrippets]. It now also includes a preview renderer for Final Draft Pro v8 XML (fdx) files. If you attach an fdx file to a Trac page, you can just click on it to view the script without having to download it.

[[Image(ScrippetMacroInAction.png, 100%, border=2)]]

== Bugs/Feature Requests

Existing bugs and feature requests for ScrippetMacro are 
[report:9?COMPONENT=ScrippetMacro here].

If you have any issues, create a 
[/newticket?component=ScrippetMacro new ticket].

[[TicketQuery(component=ScrippetMacro&group=type,format=progress)]]

== Download

Download the zipped source from [export:scrippetmacro here].

== Source

You can check out ScrippetMacro from [/svn/scrippetmacro here] using Subversion, or [source:scrippetmacro browse the source] with Trac.

== Installation

You can install this plugin using `easy_install`:
{{{
easy_install https://trac-hacks.org/svn/scrippetmacro/0.12/
}}}

== Example

{{{
{{{
#!Scrippet
EXT. ANCIENT ROME - DAY

ANTONIUS and IPSUM are walking down a tiny, crowded street.

ANTONIUS
Do you think in a thousand years, anyone will remember our names?

IPSUM
Not yours. But they'll know mine. Because I intend to write something so profound that it will be remembered for the ages. Designers in the 21st century call for Galadius Ipsum whenever they need to fill text blocks.
}}}
}}}

r11442 made some changes to formatting capabilities. Here's the above example with those changes. And you can now use standard markup in your dialog if you need it:

{{{
{{{
#!Scrippet
EXT. ANCIENT ROME - DAY

ANTONIUS and IPSUM are walking down a tiny, crowded street.

Antonius
Do you think in a thousand years, anyone will remember __our__ names?

Ipsum
Not yours. But they'll know '''mine'''. Because I intend to write something so ''profound'' that it will be ^remembered^ for the ages. Designers in the 21st century call for Galadius Ipsum whenever they need to fill text blocks.
}}}
}}}

The macro syntax for embedding a subsection should be:
{{{
[[Scrippet(fdx=<fdx>,start_with_scene=<number>[,end_with_scene=<number>])]]
Examples:
[[Scrippet(Episode 103.fdx,start_with_scene=1]] #Show scene 1 of Episode 103.fdx attached to current page
[[Scrippet(wiki:Scripts:Episode 103.fdx,start_with_scene=1,end_with_scene=3]] #Show scenes 1-3 of Episode 103.fdx attached to wiki:Scripts
}}}

The macro also includes a renderer for .fdx file. This can be enabled by changing the mimeviewer's mime_map property in your `trac.ini` file:

{{{#!ini
[mimeviewer]                                                                                                                                                         
mime_map = text/x-dylan:dylan,text/x-idl:ice,text/x-ada:ads:adb,text/fdx:fdx
}}}

== Recent Changes

[[ChangeLog(scrippetmacro, 3)]]

== Author/Contributors

'''Author:''' [wiki:netjunki] [[BR]]
'''Maintainer:''' [[Maintainer]] [[BR]]
'''Contributors:'''