AtkDocumentWriter - Revision history

Jeroenvs: /* Preventing and fixing splitted tags problem in .docx */

2008-04-21T10:42:37Z

Preventing and fixing splitted tags problem in .docx

← Older revision		Revision as of 10:42, 21 April 2008
Line 84:		Line 84:
	* or check the document.xml file in your .docx file		* or check the document.xml file in your .docx file

	This xml file can be found in the .docx file. Basically, your .docx file is a zip-archive, which you can rename to .zip and open it. 7-Zip allows you to open a .docx file as an archive directly (right click on file, 'open archive' and browse to this file):		This xml file can be found in the .docx file. Basically, your .docx file is a zip-archive, which you can rename to .zip and open it. 7-Zip allows you to open a .docx file as an archive directly (right click on file, 'open archive' and browse to this file). You can see the contents of your document in:
	word/document.xml ~~in your .docx file,~~		word/document.xml

	These rules will minimize the adding of markup:		These rules will minimize the adding of markup:

Jeroenvs: .docx support + troubleshooting

2008-04-21T10:39:11Z

.docx support + troubleshooting

@@ Line 1: / Line 1: @@
 == Description ==
-The atkDocumentWriter is the general DocumentWriter framework class. It Should be extended to support specific file formats.
+The atkDocumentWriter is the general DocumentWriter framework class. It Should be extended to support specific file formats. At this moment 2 file formats are supported:
 == Params ==
@@ Line 8: / Line 10: @@
 ===Template ===
-The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.
+The basic idea is that ''tags'' in a template-document are replaced by specified values.
 A simple template will look like this:
@@ Line 17: / Line 19: @@
   [sender]
-This is just a regular Open Office .odt document.
+This is just a regular Open Office .odt or Word2007 .docx document.
@@ Line 36: / Line 38: @@
 If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).
-=== Code ===
+=== Display document (Open Office example) ===
 Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:
-  $template_filename = "template.odt";
+  $template_filename = "oo_template.odt";
   $template_file = &$handler->getFilenameForTemplate($template_filename);
@@ Line 50: / Line 52: @@
 A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser).

Leon: Fix destruction

2007-06-08T06:52:06Z

Fix destruction

← Older revision		Revision as of 06:52, 8 June 2007
Line 3:		Line 3:

	== Params ==		== Params ==
	The constructor of the atkDocumentWriter is not directly called.		The constructor of the atkDocumentWriter is not directly called. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.

			== Examples ==
			===Template ===

			The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.

			A simple template will look like this:

			Dear [name],
			Thank you for testing this template.
			Greetings,
			[sender]

			This is just a regular Open Office .odt document.


			In your code, ''$tplvars'' is an array which contains 'tags' and 'values'.

			$tplvars["name"] = "Jeroen";
			$tplvars["sender"] = "Santa";

			In the generated document, the tags are replaced:

			Dear Jeroen,
			Thank you for testing this template.
			Greetings,
			Santa

			== Available codes ==

			If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).

			=== Code ===

			Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:

			$template_filename = "template.odt";
			$template_file = &$handler->getFilenameForTemplate($template_filename);

			The location of the template can be configured in config.inc.php: ''$config_doctemplatedir = "doctemplates/";''

			atkimport("atk.document.atkdocumentwriter");
			$dw = &atkDocumentWriter::getInstance("opendocument");
			$dw->display($template_file, "output.odt", $tplvars);

			A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser).

KufBw4 at 15:05, 7 June 2007

2007-06-07T15:05:30Z

← Older revision		Revision as of 15:05, 7 June 2007
Line 3:		Line 3:

	== Params ==		== Params ==
	The constructor of the atkDocumentWriter is not directly called~~. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.~~		The constructor of the atkDocumentWriter is not directly called.

	~~== Examples ==~~
	~~===Template ===~~

	~~The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.~~

	~~A simple template will look like this:~~

	~~Dear [name],~~
	~~Thank you for testing this template.~~
	~~Greetings,~~
	~~[sender]~~

	~~This is just a regular Open Office .odt document.~~


	~~In your code, ''$tplvars'' is an array which contains 'tags' and 'values'.~~

	~~$tplvars["name"] = "Jeroen";~~
	~~$tplvars["sender"] = "Santa";~~

	~~In the generated document, the tags are replaced:~~

	~~Dear Jeroen,~~
	~~Thank you for testing this template.~~
	~~Greetings,~~
	~~Santa~~

	~~== Available codes ==~~

	If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).

	~~=== Code ===~~

	~~Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:~~

	~~$template_filename = "template.odt";~~
	~~$template_file = &$handler->getFilenameForTemplate($template_filename);~~

	~~The location of the template can be configured in config.inc.php: ''$config_doctemplatedir = "doctemplates/";''~~

	~~atkimport("atk.document.atkdocumentwriter");~~
	~~$dw = &atkDocumentWriter::getInstance("opendocument");~~
	~~$dw->display($template_file, "output.odt", $tplvars);~~

	~~A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser)~~.

bahtiar: fix destruction

2007-04-11T07:09:21Z

fix destruction

← Older revision		Revision as of 07:09, 11 April 2007
Line 3:		Line 3:

	== Params ==		== Params ==
	The constructor of the atkDocumentWriter is not directly called.		The constructor of the atkDocumentWriter is not directly called. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.

			== Examples ==
			===Template ===

			The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.

			A simple template will look like this:

			Dear [name],
			Thank you for testing this template.
			Greetings,
			[sender]

			This is just a regular Open Office .odt document.


			In your code, ''$tplvars'' is an array which contains 'tags' and 'values'.

			$tplvars["name"] = "Jeroen";
			$tplvars["sender"] = "Santa";

			In the generated document, the tags are replaced:

			Dear Jeroen,
			Thank you for testing this template.
			Greetings,
			Santa

			== Available codes ==

			If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).

			=== Code ===

			Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:

			$template_filename = "template.odt";
			$template_file = &$handler->getFilenameForTemplate($template_filename);

			The location of the template can be configured in config.inc.php: ''$config_doctemplatedir = "doctemplates/";''

			atkimport("atk.document.atkdocumentwriter");
			$dw = &atkDocumentWriter::getInstance("opendocument");
			$dw->display($template_file, "output.odt", $tplvars);

			A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser).

FgaJla at 21:48, 10 April 2007

2007-04-10T21:48:12Z

← Older revision		Revision as of 21:48, 10 April 2007
Line 3:		Line 3:

	== Params ==		== Params ==
	The constructor of the atkDocumentWriter is not directly called~~. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.~~		The constructor of the atkDocumentWriter is not directly called.

	~~== Examples ==~~
	~~===Template ===~~

	~~The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.~~

	~~A simple template will look like this:~~

	~~Dear [name],~~
	~~Thank you for testing this template.~~
	~~Greetings,~~
	~~[sender]~~

	~~This is just a regular Open Office .odt document.~~


	~~In your code, ''$tplvars'' is an array which contains 'tags' and 'values'.~~

	~~$tplvars["name"] = "Jeroen";~~
	~~$tplvars["sender"] = "Santa";~~

	~~In the generated document, the tags are replaced:~~

	~~Dear Jeroen,~~
	~~Thank you for testing this template.~~
	~~Greetings,~~
	~~Santa~~

	~~== Available codes ==~~

	If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).

	~~=== Code ===~~

	~~Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:~~

	~~$template_filename = "template.odt";~~
	~~$template_file = &$handler->getFilenameForTemplate($template_filename);~~

	~~The location of the template can be configured in config.inc.php: ''$config_doctemplatedir = "doctemplates/";''~~

	~~atkimport("atk.document.atkdocumentwriter");~~
	~~$dw = &atkDocumentWriter::getInstance("opendocument");~~
	~~$dw->display($template_file, "output.odt", $tplvars);~~

	~~A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser)~~.

Guido at 16:24, 30 November 2006

2006-11-30T16:24:00Z

← Older revision		Revision as of 16:24, 30 November 2006
Line 31:		Line 31:
	Greetings,		Greetings,
	Santa		Santa

			== Available codes ==

			If you want to know which codes are available in a document, you can use the [taglist] tag in a template document. When using the documentwriter on this template, the resulting document will contain a list of all available tags (including loops which can be used in tables).

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

bahtiar at 07:22, 29 September 2006

2006-09-29T07:22:53Z

← Older revision		Revision as of 07:22, 29 September 2006
Line 1:		Line 1:
	=== Description ===		== Description ==
	The atkDocumentWriter is the general DocumentWriter framework class. It Should be extended to support specific file formats.		The atkDocumentWriter is the general DocumentWriter framework class. It Should be extended to support specific file formats.

	=== Params ===		== Params ==
	The constructor of the atkDocumentWriter is not directly called. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.		The constructor of the atkDocumentWriter is not directly called. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.

	=== Examples ===		== Examples ==
	====Template ====		===Template ===

	The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.		The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.
Line 32:		Line 32:
	Santa		Santa

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

	Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:		Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:

bahtiar: Atkdocumentwriter moved to AtkDocumentWriter

2006-09-29T07:17:33Z

Atkdocumentwriter moved to AtkDocumentWriter

← Older revision	Revision as of 07:17, 29 September 2006
(No difference)

Jeroenvs at 10:07, 26 September 2006

2006-09-26T10:07:08Z

New page

=== Description ===
The atkDocumentWriter is the general DocumentWriter framework class. It Should be extended to support specific file formats.

=== Params ===
The constructor of the atkDocumentWriter is not directly called. &atkDocumentWriter::getInstance($format) must be used to get a singleton instance for any format used.

=== Examples ===
====Template ====

The basic idea is that ''tags'' in a template-document are replaced by specified values. For now, the only document type supported is Open Office.

A simple template will look like this:

Dear [name],
Thank you for testing this template.
Greetings,
[sender]

This is just a regular Open Office .odt document.

In your code, ''$tplvars'' is an array which contains 'tags' and 'values'.

$tplvars["name"] = "Jeroen";
$tplvars["sender"] = "Santa";

In the generated document, the tags are replaced:

Dear Jeroen,
Thank you for testing this template.
Greetings,
Santa

==== Code ====

Use the atkDocumentWriter in an action for example. When a button is pressed, a document will be generated:

$template_filename = "template.odt";
$template_file = &$handler->getFilenameForTemplate($template_filename);

The location of the template can be configured in config.inc.php: ''$config_doctemplatedir = "doctemplates/";''

atkimport("atk.document.atkdocumentwriter");
$dw = &atkDocumentWriter::getInstance("opendocument");
$dw->display($template_file, "output.odt", $tplvars);

A 'Save as..' dialog will popup in your browser to save the document (or it will be displayed inline, when configured in the browser).