InkSlide - Revision history

Newacct at 00:19, 14 December 2010

2010-12-14T00:19:45Z

← Older revision		Revision as of 00:19, 14 December 2010
Line 462:		Line 462:
	r.set('x', str(tabDim[tabs]['x']))		r.set('x', str(tabDim[tabs]['x']))
	y = tabDim[tabs]['y'] + delta		y = tabDim[tabs]['y'] + delta
	#print '%s -> %s' % ~~(str~~(r.get('y')), ~~str(~~y))		#print '%s -> %s' % (r.get('y'), y)
	#print tabDim[tabs]['y']		#print tabDim[tabs]['y']
	r.set('y', str(y))		r.set('y', str(y))

Terry brown: /* Code */

2008-02-01T02:56:16Z

Code

Show changes

Terry brown: Undo revision 16497 by Terry brown (Talk)

2007-10-23T17:36:58Z

Undo revision 16497 by Terry brown (Talk)

← Older revision		Revision as of 17:36, 23 October 2007
Line 9:		Line 9:
	<pre>		<pre>
	InkSlide: Features		InkSlide: Features
	~~=== Download ===~~		++++++++++++++++++

			Features include wrapped top level text and
			- mulitple
			- levels
			- of wrapped bulleted lists with bullets and font
			information taken from the template file.

			Slide specific content like this:


	~~Copy~~ the ~~[[InkSlide#Code\|text below]] into a file called 'inkslide~~.~~py'. (How do you attach a non-image file on this wiki?)~~		which is updated when the template changes.
			</pre>

	~~InkSlide~~ is ~~undergoing rapid development at~~ the ~~moment~~ and ~~the code below may~~ be ~~out of date~~ and ~~may not match these instructions~~.		An Inkscape file is used as a template file to define the background, title position and font, fonts and positions for text at different levels of indentation, groups to be cloned and used as bullets, etc.

	~~Here is an [[Media:template0.svg\|example~~ template~~]]. Use Save Link As~~ to ~~stop your browser displaying~~ the ~~file instead of downloading it~~.		Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

	=== Download ===		=== Download ===
Line 63:		Line 73:
	<pre>		<pre>
	Inkslide: an example		Inkslide: an example
	~~====================~~		++++++++++++++++++++

	This text will appear as a top level paragraph.		This text will appear as a top level paragraph.
Line 84:		Line 94:

	Inkslide: the next slide...		Inkslide: the next slide...
	~~===========================~~		+++++++++++++++++++++++++++
	</pre>		</pre>

Terry brown: /* Download */

2007-10-23T17:30:58Z

Download

← Older revision		Revision as of 17:30, 23 October 2007
Line 9:		Line 9:
	<pre>		<pre>
	InkSlide: Features		InkSlide: Features
	===~~============~~===		=== Download ===

	~~Features include wrapped top level~~ text ~~and~~		Copy the [[InkSlide#Code\|text below]] into a file called 'inkslide.py'. (How do you attach a non-image file on this wiki?)
	~~- mulitple~~
	~~- levels~~
	- ~~of wrapped bulleted lists with bullets and font~~
	~~information taken from the template~~ file.

	~~Slide specific content like this:~~		InkSlide is undergoing rapid development at the moment and the code below may be out of date and may not match these instructions.

			Here is an [[Media:template0.svg\|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.
	~~which~~ is ~~updated when the~~ template ~~changes~~.
	~~</pre>~~

	~~An Inkscape file is used as a template file~~ to ~~define~~ the ~~background, title position and font, fonts and positions for text at different levels~~ of ~~indentation, groups to be cloned and used as bullets, etc.~~

	Content specific to a particular slide can also be created in Inkscape, this content merged with the template and text input to make the final slide, so changes to the template after a particular slide is edited in Inkscape are included.

	=== Download ===		=== Download ===

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

2007-10-23T17:29:26Z

InkSlide - quick and easy presentations using Inkscape

← Older revision		Revision as of 17:29, 23 October 2007
Line 67:		Line 67:

	When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.		When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.

	~~=== The Template File ===~~

	~~The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.~~

	~~Required contents:~~

	*A layer called ''Texts'', into which text will be placed.
	*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
	*A group with an @id of ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
	*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
	*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

	~~The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.~~

	~~Optional contents:~~

	*A background
	*Affiliation text and logos you want to appear on every slide
	*A blurred clone of the gr_title element, offset and behind it.
	*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

	When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible, or at least hidden below the background layer, which should be visible. Likewise the Texts layer should be visible, as well as any Instance layers.

	=== Text Input ===		=== Text Input ===

Terry brown: /* The Template File */

2007-10-23T17:27:37Z

The Template File

← Older revision		Revision as of 17:27, 23 October 2007
Line 41:		Line 41:
	Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.		Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

	=== ~~How it works~~ ===		=== The Template File ===

	~~First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the~~ template file ~~with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in~~ a ~~layer called 'Texts'~~. At this ~~point~~, the ~~text is all piled up at the top of the page~~.		The template file is a regular Inkscape file. If this list seems hard, just use the example template and modify it to suit your needs.

	InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.		Required contents:

	~~Finally~~, ~~InkSlide checks~~ to ~~see if there~~'s an %id ~~tag~~ for the ~~slide~~, and ~~if so if there~~'s a ~~corresponding Inkscape SVG file~~ with ~~content for~~ this ~~particular slide~~. ~~This content has~~ to ~~occur in layers~~ whose name starts with ''Instance''~~, and~~ these layers ~~have to be present~~ in the template file~~, but~~ you ~~can have more than one, so they can be above~~ and ~~below the regular content~~. ~~If such content is found~~, ~~it's copied into the output slide~~.		*A group or layer called ''gr_text'', into which text will be placed.
			*A flowed text frame with an @id of ''fr_title'' to define the font and position for the slide title. This should contain text like ''Title goes here Sly'' because ''Sly'' includes letters which ascend and descend from the baseline to the greatest extent. The placeholder text must be '''only''' one line because it's used to calculate line height.
			*A group or layer called ''gr_title'' into which the title will be placed. This makes it easier to do special effects on the title like shadows.
			*Flowed text frames with an @id of ''fr_tabN'' for each N in 0, 1, 2, 3. ''fr_tab0'' is used for top level non bulleted text. These should also include ''Sly'' or similar. The placeholder text must be '''only''' one line because it's used to calculate line height.
			*Objects or groups withan @id of ''bu_N'' for each N in 1, 2, 3, for the three levels of bulleted list.

			The fr_* elements define the font, font-size, color etc. for the different levels of text. They also define the position and wrap width. See the example template file for a possible arrangement.

			"A group or layer called 'X'" indicates either a group with an '''@id'''
			of 'X' ''or'' a layer with a '''label''' (name) of 'X'. When both exist the group will take precedence.

			Optional contents:

			*A background, which should be placed in a group or layer called `gr_bg`
			*A foreground, which should be placed in a group or layer called `gr_fg`
			*Affiliation text and logos you want to appear on every slide, this could go in the background, or another named group or layer.
			*A blurred clone of the gr_title element, offset and behind it. It's easier to do this is `gr_title` is a group rather than a layer.
			*Layers whose name starts with ''Instance'' - these are the layers the user can edit directly in Inkscape for a particular slide.

			When you save the template file you should make sure that layers containing place holder text (the fr_* elements) and bullets are invisible. Likewise the Texts layer should be visible, as well as any Instance layers.

	=== The Template File ===		=== The Template File ===

Terry brown: /* How it works */

2007-10-23T17:21:09Z

How it works

← Older revision		Revision as of 17:21, 23 October 2007
Line 33:		Line 33:
	Here is an [[Media:template0.svg\|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.		Here is an [[Media:template0.svg\|example template]]. Use Save Link As to stop your browser displaying the file instead of downloading it.

	=== ~~Use~~ ===		=== How it works ===

	~~<pre>python inkslide~~.~~py myTemplate~~.~~svg mySlides~~.~~txt</pre>~~		First InkSlide parses the text input, something like the example at the top of this page. It looks for flowed text boxes in the template file with special @id attributes like ''fr_title'' for the title, and ''fr_tab2'' for the second level of bulleted lists. Copies of these elements are made and placed in a layer called 'Texts'. At this point, the text is all piled up at the top of the page.

	~~This creates a slide00xx~~.~~svg~~ for ~~each slide in your presentation~~.		InkSlide saves the file, and uses Inkscape's command line ''--query-height'' and friends to find out how high the wrapped text pieces are. At it then repositions them properly, adds clones of the bullet markers, etc. Bullet markers have special @id attributes like ''bu_1'' for the first level of bulleted list.

	~~<pre>python inkslide.py --writeInstance <instanceId> myTemplate.svg mySlides.txt</pre>~~		Finally, InkSlide checks to see if there's an id tag for the slide, and if so if there's a corresponding Inkscape SVG file with content for this particular slide. This content has to occur in layers whose name starts with ''Instance'', and these layers have to be present in the template file, but you can have more than one, so they can be above and below the regular content. If such content is found, it's copied into the output slide.

	~~Creates / updates~~ the Inkscape file ~~you can edit to add special~~ content to this particular slide. '''~~NOT IMPLEMENTED YET~~'~~'' -~~ the ~~code exists~~, but ~~not~~ the ~~command line hook~~.

	=== How it works ===		=== How it works ===

Terry brown: /* InkSlide - quick and easy presentations using Inkscape */

2007-10-23T17:19:46Z

InkSlide - quick and easy presentations using Inkscape

← Older revision		Revision as of 17:19, 23 October 2007
Line 8:		Line 8:

	<pre>		<pre>
	~~%slide~~ InkSlide: Features		InkSlide: Features
			==================

	Features include wrapped top level text and		Features include wrapped top level text and
	mulitple		- mulitple
	levels		- levels
	of wrapped bulleted lists with bullets and font		- of wrapped bulleted lists with bullets and font
	information taken from the template file.		information taken from the template file.

	Slide specific content like this:		Slide specific content like this:

Terry brown: /* Text Input */

2007-10-23T17:18:47Z

Text Input

← Older revision		Revision as of 17:18, 23 October 2007
Line 73:		Line 73:

	=== Text Input ===		=== Text Input ===

			InkSlide uses [http://docutils.sourceforge.net/rst.html reStructuredText] for markup, although it renders only a subset of rst.

	<pre>		<pre>
	~~%title~~ Inkslide: an example		Inkslide: an example
			====================

	This text will appear as a top level paragraph.		This text will appear as a top level paragraph.
	~~Indented by a single tab, this text will appear as a bulleted item.~~
	~~Two tabs -> second level bulleted list.~~

	~~A gap~~ will ~~be left for the preceeding line~~.		- Dash prefix indicates this text will appear as a bulleted item.
	%pause
	Two slides will be produced for this input, one with everything up to the %pause ~~above~~,		- Indented dash prefix -> second level bulleted list.
	and one with that plus the remaining content.
			.. is:pause

			Two slides will be produced for this input, one with everything up to the
			".. is:pause", and one with that plus the remaining content.
	Incremental list display can be done this way.		Incremental list display can be done this way.

	The %id tag below indicates that a file with a name like 'extra/is_intro.svg' should		The is:id tag below indicates that a file with a name like
	be inspected for extra content for this particular slide.		'extra/is_intro.svg' should be inspected for extra content
	%id is_intro		for this particular slide.
	~~%title~~ Inkslide: the next slide...
			.. is:id is_intro

			Inkslide: the next slide...
			===========================
	</pre>		</pre>

Terry brown: /* Author / Credits */

2007-10-23T17:13:38Z

Author / Credits

← Older revision		Revision as of 17:13, 23 October 2007
Line 124:		Line 124:

	InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]		InkSlide was inspired by [http://member.wide.ad.jp/wg/mgp/ MagicPoint]

			Matt Harrison suggested using reStructured text as the markup language.

	=== Code ===		=== Code ===