From 31724c91fc8a3957db56e768896a9227460736a3 Mon Sep 17 00:00:00 2001 From: Nicolas Spalinger Date: Thu, 22 Aug 2024 11:02:04 -0500 Subject: [PATCH] Added small paragraph about .tex files in the tests/ folder --- docs/smith/test.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/smith/test.adoc b/docs/smith/test.adoc index 40b0d718..ea159fab 100644 --- a/docs/smith/test.adoc +++ b/docs/smith/test.adoc @@ -30,6 +30,9 @@ htex:: ftml:: `.xml` files are treated the same as `.ftml` files. +WARNING: Don't put raw `.tex` files in the special `tests/` folder since smith does not know how to handle them properly right now. You need to put them in another folder. +But `.odt` (OpenDocument) and `.indd` (InDesign) are fine. + === Standard commands (targets) === Test source files are stored in a standard place in the tree. The global variable @@ -120,7 +123,7 @@ the generated `ftml_index.html` file that creates complex links that run a parti xsl file against a particular ftml file giving the font and technology and script. The xsl file then generates an html report for the .ftml file given the font and that is then displayed in the browser. In order to make the browser be able to load the various fonts and files, these and the -necessary supporting files are copied into the results tests tree for this target. The test also supports .txt and .htxt test file types, converting them into .ftml as they are copied. +necessary supporting files are copied into the `results` tests folder for this target. The test also supports .txt and .htxt test file types, converting them into .ftml as they are copied. By default, smith does not come with any .ftml .xsl report generators already built in. Currently a wscript author has to specify where such an .xsl file may be found. They can do this using the `ftmlTest()` function that takes one parameter (a local path to an .xsl file) and various named parameters: