@@ -5,8 +5,7 @@ refer to the Ximera manual, which explains things in more detail and in a more u
55
66# General Structure and Intent of this Repo
77
8- This Repo (will) be structured as follows...
9-
8+ * ** This Repo (will eventually be) structured as follows...**
109
1110- masterTestFolder
1211 - (DTXFileName)Test.tex files (e.g. problemTest.tex)
@@ -24,23 +23,20 @@ This Repo (will) be structured as follows...
2423 - (dtxFileName)Test.tex files for the dtx files with no testable elements (e.g. banner.dtx)
2524
2625
27- ** testFiles Folder at a glance**
28-
26+ * ** testFiles Folder at a glance**
2927The testFiles folder is the folder that contains all the actual test ximera document class files
3028that are loaded and used for demo/testing. Files in this folder should adhere to a specific naming
3129scheme, and by large should not need to be edited after they have been finalized as testing bed files.
3230(More on this below).
3331
34- ** masterTestFolder Folder at a glance**
35-
32+ * ** masterTestFolder Folder at a glance**
3633The masterTestFolder is the location of all the xourse files that represent tests for each of the
3734possible (individual) areas for testing - e.g. ''problem'' type environments or ''maketitle'' command.
3835Again, these all adhere to a specific naming scheme and should not need to be edited once they have
3936been verified as valid testbed files until/unless more content is added to its category.
4037(Again, more on this below).
4138
42- ** testGroupings Folder at a glance**
43-
39+ * ** testGroupings Folder at a glance**
4440Finally, the testGroupings folder is likely where most of the testing will actually take place. This
4541folder should contain a list of folders that represent ''types'' of content that may need to be verified
4642or tested - e.g. ''environments'', ''answerables'' or ''authorship tools''. More folders may be added here
@@ -50,8 +46,7 @@ like the ``\answer`` command is likely to show up under a lot of different categ
5046testing (e.g. ''student interactions'', ''page credit generating elements'', and ''javascript elements'' would
5147all have the `` \answer `` command as a relevant test).
5248
53- ** Important Note About Test Groupings**
54-
49+ * ** Important Note About Test Groupings**
5550To ensure all tests stay up to date in the relevant testGroupings (and to avoid version mismatch and general confusion)
5651the files inside the testGroups will be symlinks to the relevant test xourse in the masterTestFolder. So the only
5752real test xourses will be the files in the master test folder - meaning there is only one file to update and keep
@@ -60,7 +55,7 @@ track of, and any changes to that one file will automatically update all relevan
6055
6156# Naming Schemes
6257
63- * Each test xourse is named after a dtx file, and every dtx file should have a test xourse named after it (with some exceptions, see below).
58+ * ** Each test xourse is named after a dtx file and every dtx file has a test xourse. **
6459Since all development work must be implemented via dtx file (as per CTAN standards) and most development work
6560tends to involve only a few dtx files (usually just one or two), it is often easiest to test the new code by testing
6661everything that is implemented by the newly changed dtx code. This testing bed makes that easy to accomplish by merely
@@ -70,15 +65,16 @@ i.e. each command/environment (or reasonably obvious groupings, like all ``\newt
7065in the same place) has its own testing tile, making it relatively easy to investigate updated content, even inside a given dtx.
7166Thus ** Each test xourse should be named (dtxFileName)Test.tex** e.g. ''abstractTest.tex'' for the ''abstract.dtx'' file.
7267
73- * Each test file in the testFiles folder is named after the relevant command, environment, etc that it is testing.
68+ * ** Each test file is named after the relevant command/ environment/ etc that it is testing.**
7469In most cases, this means it will be named the same as the dtx file (e.g. the ''abstract'' test file for the ''abstractTest''
7570xourse). However, often there are a number of options, or other elements that need to be demo'ed/testable for a given
7671command/environment/etc. We don't want to have a single test file that contains all the various complexities of these
7772things, as it becomes difficult to see what aspect ended up generating issues (if there are issues from a new update).
7873Thus test files should have a ''Base'' version that is the minimal implementation of the tested item, and then various
7974other files that demo/test the other relevant aspects.
8075
81- * As a special note, some specific test files/xourses need to load specific options or alternative files as part of their
76+ * ** When Preambles are Necessary**
77+ Some specific test files/xourses need to load specific options or alternative files as part of their
8278testing (e.g. the graphics testing file needs to input graphics, and set graphics paths in the preamble). When this is
8379necessary, ** do note use the xmpreamble** for the test repo - instead you should make a preamble with the relevant test
8480file (or xourse as appropriate) name, appended with ''preamble'' - e.g. ''imagePreamble.tex'' is the preamble file
0 commit comments