Yet more function documentation

git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@573 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
twanvl
2007-07-14 01:08:08 +00:00
parent 0d6233c92b
commit c212c56806
10 changed files with 182 additions and 2 deletions
+22
View File
@@ -0,0 +1,22 @@
Function: write_text_file
--Usage--
> write_text_file(some_string, file: filename)
Write a string to a file in the output directory.
If a file with the given name already exists it is overwritten.
Returns the name of the file written.
This function can only be used in an [[type:export template]], when <tt>create directory</tt> is true.
--Parameters--
! Parameter Type Description
| @input@ [[type:string]] Text to write to the file.
| @file@ [[type:string]] Name of the file to write to
--Examples--
> write_file("index.html", lots_of_html_code) == "index.html" # index.html now contains the given text
--See also--
| [[fun:write_image_file]] Write an image file to the output directory.