Skip to content

Commit

Permalink
Added small paragraph about .tex files in the tests/ folder
Browse files Browse the repository at this point in the history
  • Loading branch information
n7s committed Aug 22, 2024
1 parent 788b3d5 commit 31724c9
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/smith/test.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 31724c9

Please sign in to comment.