@@ -10,11 +10,12 @@ refer to the Ximera manual, which explains things in more detail and in a more u
1010- masterTestFolder
1111 - (DTXFileName)Test.tex files (e.g. problemTest.tex)
1212- testFiles
13- - (command/Env)Base.tex files (e.g. problemBase.tex)
14- - (command/Env)(Additional Testing Feature).tex (e.g. problemNesting.tex or problemNumbering.tex)
13+ - (Command/Env) folder; a folder for each testable command/enviroment/etc. (e.g. ''problem'' folder)
14+ - base.tex file (basic usage implementation/info)
15+ - (Additional Testing Feature).tex (e.g. nesting.tex or numbering.tex in the problem folder)
1516- testGroups
1617 - (Group By Type) folder. (e.g. ''environments'' or ''authorTools'' folders)
17- - Each folder contains a group of test xourses relevant to that grouping .
18+ - Each folder contains a test xourse that loads the activities from all relevant folders in the testFiles folder .
1819- untestedDTX
1920 - depreciated folder
2021 - (dtxFileName)Test.tex files for dtx files that contain only content that
@@ -26,7 +27,8 @@ refer to the Ximera manual, which explains things in more detail and in a more u
2627* ** testFiles Folder at a glance**
2728The testFiles folder is the folder that contains all the actual test ximera document class files
2829that are loaded and used for demo/testing. Files in this folder should adhere to a specific naming
29- scheme, and by large should not need to be edited after they have been finalized as testing bed files.
30+ scheme, and should only need minor editing once they have been finalized as testing bed files
31+ although more files will be added as we do more development.
3032(More on this below).
3133
3234* ** masterTestFolder Folder at a glance**
@@ -37,8 +39,9 @@ been verified as valid testbed files until/unless more content is added to its c
3739(Again, more on this below).
3840
3941* ** testGroupings Folder at a glance**
40- Finally, the testGroupings folder is likely where most of the testing will actually take place. This
41- folder should contain a list of folders that represent ''types'' of content that may need to be verified
42+ Finally, the testGroupings folder will have a quick-ref/links/generated-Xourses that will allow
43+ us to test content by type, rather than dtx file. This folder should contain
44+ a list of folders that represent ''types'' of content that may need to be verified
4245or tested - e.g. ''environments'', ''answerables'' or ''authorship tools''. More folders may be added here
4346as we determine elements that are commonly needed to test together/in tandem. Note that the intent here,
4447is that the same test file/xourse may appear in multiple (indeed many) of these subfolders... since something
@@ -65,13 +68,16 @@ i.e. each command/environment (or reasonably obvious groupings, like all ``\newt
6568in the same place) has its own testing tile, making it relatively easy to investigate updated content, even inside a given dtx.
6669Thus ** Each test xourse should be named (dtxFileName)Test.tex** e.g. ''abstractTest.tex'' for the ''abstract.dtx'' file.
6770
68- * ** Each test file is named after the relevant command/environment/etc that it is testing.**
69- In most cases, this means it will be named the same as the dtx file (e.g. the ''abstract'' test file for the ''abstractTest''
70- xourse). However, often there are a number of options, or other elements that need to be demo'ed/testable for a given
71- command/environment/etc. We don't want to have a single test file that contains all the various complexities of these
72- things, as it becomes difficult to see what aspect ended up generating issues (if there are issues from a new update).
73- Thus test files should have a ''Base'' version that is the minimal implementation of the tested item, and then various
74- other files that demo/test the other relevant aspects.
71+ * ** Each tested command/env/etc has a folder in the testFiles folder**
72+ Each command/environment/etc that has a test file will have a folder with that command/environment/etc name
73+ (e.g. ''problem'' folder or '' link'' folder in the testFiles folder). In that folder will be a basic usage/test file
74+ called ''base.tex'' that tests/demos the most basic implementation of whatever is being tested.
75+ However, often there are a number of options, or other elements for whatever is being tested that also need a demo/test.
76+ We don't want to have a single test file that contains all the various complexities of these things,
77+ as it becomes difficult to see what aspect ended up generating issues (if there are issues from testing).
78+ Thus test files should have the ''base.tex'' file that is the minimal implementation of the tested item, and then various
79+ other files that demo/test the other relevant aspects, each named after whatever it tests (e.g. ''numbering'' or ''nesting''
80+ for demo/testing the numbering scheme and nesting behavior inside the problem subfolder in the testFiles folder.).
7581
7682* ** When Preambles are Necessary**
7783Some specific test files/xourses need to load specific options or alternative files as part of their
@@ -85,12 +91,22 @@ server name/code to the test file. For example, if OSU has intended behavior tha
8591then there should be a ''hintsOSU'' or possibly a ''hintsBaseOSU'' as appropriate.
8692
8793* ** Example of Intended Naming Scheme:**
88- To demonstrate the intended naming scheme, consider the problem-like environments. The tests need to have a base case that
94+ To demonstrate the intended naming scheme, consider the problem-like environments. The thing being tested is the ''problem''
95+ environment, so all tests go into a ''problem'' folder inside the testFiles folder. We need the base case that
8996demo/tests the very bare implementation of the problem like environments - but it also requires a test for how problem
90- numbering is handled, and a test for how nesting problems is handled. Thus there should be three test files;
91- problemBase.tex, problemNesting.tex, and problemNumbering.tex - each is a ximera documentclass that is demoing/testing
92- the basic implementation, nesting behavior, and numbering scheme respectivvely. These are in turn loaded by the
97+ numbering is handled, and a test for how nesting problems is handled. Thus there should be three test files inside the problem
98+ subfolder of the testFiles folder; problemBase.tex, problemNesting.tex, and problemNumbering.tex.
99+ each is a ximera documentclass that is demoing/testing the basic implementation, nesting behavior,
100+ and numbering scheme respectivvely. These are in turn loaded by the
93101''problemTest.tex'' file, which is the xourse documentclass that loads the content generated in the problem.dtx file.
102+ So just the ''problem'' related files would be in the structure as follows:
103+ - masterTestFolder
104+ - problemTest.tex
105+ - testFiles
106+ - problem
107+ - base.tex file (basic usage implementation/info)
108+ - nesting.tex (demo/test for nesting behavior)
109+ - numbering.tex (demo/test for numbering scheme)
94110
95111# Non-Testable dtx Files Explained
96112
0 commit comments