Updates to the GitKit Text from January 2025 Sprint

.devcontainer.json

@@ -15,9 +15,9 @@
   "name": "PreTeXt-Codespaces",
 
   // This Docker image includes some LaTeX support, but is still not to large.  Note that if you keep your codespace running, it will use up your GitHub free storage quota.  Additional options are listed below.
-  "image": "oscarlevin/pretext:small",
+  // "image": "oscarlevin/pretext:small",
   // If you need to generate more complicated assets (such as sageplots) or use additional fonts when building to PDF, comment out the above line and uncomment the following line.
-  // "image": "oscarlevin/pretext:full",
+  "image": "oscarlevin/pretext:full",
   // If you only intend to build for web and don't have any latex-image generated assets, you can use a smaller image:
   // "image": "oscarlevin/pretext:lite",
 

.github/workflows/pretext-cli.yml

@@ -24,8 +24,21 @@ jobs:
             - name: install deps
               run: pip install -r requirements.txt
 
+            - name: install local ptx files
+              run: pretext --version
+
             - name: build deploy targets
-              run: pretext build --deploys
+              run: |
+                version="$(pretext --version)"
+                major="$(echo $version | cut -d '.' -f 1)"
+                minor="$(echo $version | cut -d '.' -f 2)"
+                if [ "$major" -ge 2 -a "$minor" -ge 5 ]; then
+                    echo "PreTeXt version is 2.5 or greater; using new build command"
+                    pretext build --deploys
+                else
+                    echo "PreTeXt version is less than 2.5, using old build command"
+                    pretext build
+                fi
             - name: stage deployment
               run: pretext deploy --stage-only
 

.gitkit-cspell.txt

@@ -1,4 +1,5 @@
 automations
+devenv
 farmdata
 foss
 gitkit
@@ -8,6 +9,7 @@ halign
 HFOSSedu
 inclusivity
 kitclient
+nbsp
 opensource
 POGIL
 Runestone

README.md

@@ -2,9 +2,7 @@
 
 This repository contains the pretext source for the GitKit Runestone texts.  
 
-If you are interested in using the GitKit Text please see the Instructor Guide in the text on Runestone by using one of the following links:
-- [GitKit (Linux Desktop Edition)](https://runestone.academy/ns/books/published/gitkitlinux/the-gitkit-book.html?mode=browsing) - students work in a full Linux desktop environment in this edition.
-- [GitKit (VSCode Edition)](https://runestone.academy/ns/books/published/gitkitvscode/the-gitkit-book.html?mode=browsing) - students work within the VSCode IDE in this edition.
+If you are interested in using the GitKit Text please see the Instructor Guide in the text on Runestone by using one of the following link: [GitKit](https://runestone.academy/ns/books/published/gitkitlinux/the-gitkit-book.html?mode=browsing)
 
 ## Licensing
 
@@ -301,76 +299,19 @@ An `<exercise>` containing `<task>`s can be used to create a question with multi
 Note:
 - Fill-in questions are not currently suported within a `<task>`.  A [free response question](https://runestone.academy/ns/books/published/PTXSB/rune-20.html) (with [source](https://runestone.academy/ns/books/published/PTXSB/rune-20.html)) should be used instead. Note that the free response box only renders when running in Runestone.  This is because free response must be hand graded and cannot be auto checked in a static web deploy.  See [Using a fill in the blank exercise in a task](https://groups.google.com/g/pretext-support/c/VWLb_W0AT18) for updates on this issue.
 
-#### Adding Version Specific Content
+#### Text Versions
 
-There are 10 versions of the text that can be built:
+There are 3 versions of the text that can be built:
 
-- `student-web-linux` and `student-print-linux` - The Linux KitClient book as students will see it.
-- `student-web-vscode` and `student-print-vscde` - The VSCode KitClient book as students will see it.
-
-- `instructor-web-linux` and `instructor-print-linux` - The Linux KitClient book including notes to the instructor (see below).
-- `instructor-web-vscode` and `instructor-print-vscode` - The VSCode KitClient book including notes to the instructor (see below).
-
-- `web` and `print` - same as the instructor Linux version.  This is included for the CodeChat preview.
+- `web` - An HTML version of the text.  This will some but not all of the interactive Runestone question types.
+- `print` - A PDF version of the text.
+- `runestone` - The version built to be served by Runestone Academy.
 
 ##### Building a Specific Version
 
 Any of these versions can be built using "Build another target..." option on the `PreTeXt` menu or by using terminal commands similar to:
 
 ```text
-pretext build instructor-web-linux
-pretext view instructor-web-linux
-```
-
-##### Adding KitClient Specific Content
-
-Content specific to a given kit client is indicated by adding a `component` attribute to to divisions/elements as follows:
-
-```
-  <p 
-    component="linux-kit-client"
-    xml:id="topic-some-stuff-linux">
-    This text appears only in the Linux Kit Client versions.
-  </p>
-
-  <p 
-    component="vscode-kit-client"
-    xml:id="topic-some-stuff-vscode">
-    This text appears only in the VSCode Kit Client versions.
-  </p>
-```
-
-- If a division/element will appear only in the `linux` or `vscode` version of the text its `xml:id` should have a suffix indicating its version.  
-- If two divisions/elements provide alternate content for the `linux` and `vscode` versions their `xml:ids` will be the same except for the suffix. 
-
-##### Instructor Version Content
-
-A `commentary` element with the `component="instructor"` attrribute is used to add instructor guide information directly to the source text as follows:
-
-```xml
- <commentary component="instructor">
-    <tabular top="major" bottom="major" left="major" right="major">
-      <col width="100%" />
-      <row>
-        <cell>
-          <p>
-            <alert>Instructor Note:</alert>: Information for the instructor appears here.
-          </p>
-        </cell>
-      </row>
-    </tabular>
-  </commentary>
-```
-
-Note:
-- The `<tabular>` is included to place all comments for the instructor into a box.
-
-##### Defining a Version
-
-The available versions are defined by the `<target>`s in the `project.ptx` file.  Each `<target>` references a `.ptx` file in the `publication` folder that indicates the content that will appear in the version.
-
-##### Publishing a Version
-
-Runestone does not currently support the publication of different versions of a text from a single repository. Instead, the solution is to create a fork of this repository. Then in that repository change the `publication` file that is the `target` of the `runestone` target to point to the `publication` file for the version that you would like to publish.  Then create a new Runestone text using that repository.
-
-See the [GitKit-VSCode Repository](https://github.com/HFOSSedu/GitKit-VSCode) for an example.  That repository also includes information about how to update it from this repository when edits are made.
+pretext build web
+pretext view web
+```

project.ptx

@@ -2,27 +2,10 @@
 <!-- This file, the project manifest, provides the overall configuration for your PreTeXt project. To edit the content of your document, open `source/main.ptx`. See https://pretextbook.org/doc/guide/html/processing-CLI.html#cli-project-manifest. -->
 <project ptx-version="2">
   <targets>
-    <target name="web" format="html" publication="publication-instructor-linux.ptx"/>
-    <target name="print" format="pdf" publication="publication-instructor-linux.ptx"/>
+    <target name="web" format="html" publication="publication.ptx"/>
+    <target name="print" format="pdf" publication="publication.ptx"/>
 
     <!-- This is the target that is built on runestone -->
-    <!-- It will need to be made to point to the vscode publication file in the fork for that edition. -->
-    <!-- The output-dir should also be changed to a unique directory for the VSCode version. -->
-    <target name="runestone" format="html" publication="publication-runestone-linux.ptx" output-dir="published/gitkitlinux" />
-
-    <!--
-    <target name="runestone-linux" format="html" publication="publication-runestone-linux.ptx" output-dir="publication/gitkit" />
-    <target name="runestone-vscode" format="html" publication="publication-runestone-vscode.ptx" output-dir="publication/gitkit" />
-    -->
-
-    <target name="student-web-linux" format="html" publication="publication-student-linux.ptx"/>
-    <target name="student-print-linux" format="pdf" publication="publication-student-linux.ptx"/>
-    <target name="instructor-web-linux" format="html" publication="publication-instructor-linux.ptx"/>
-    <target name="instructor-print-linux" format="pdf" publication="publication-instructor-linux.ptx"/>
-
-    <target name="student-web-vscode" format="html" publication="publication-student-vscode.ptx"/>
-    <target name="student-print-vscode" format="pdf" publication="publication-student-vscode.ptx"/>
-    <target name="instructor-web-vscode" format="html" publication="publication-instructor-vscode.ptx"/>
-    <target name="instructor-print-vscode" format="pdf" publication="publication-instructor-vscode.ptx"/>
+    <target name="runestone" format="html" publication="publication-runestone.ptx" output-dir="published/gitkit" />
   </targets>
 </project>

publication/publication-student-linux.ptx → publication/publication-example.ptx

@@ -21,7 +21,7 @@
     <!-- Style of fill-in-the-blanks: -->
     <fillin textstyle="underline" mathstyle="shade" />
     <!-- You can set a watermark: -->
-    <!-- <watermark scale="1.0">DRAFT</watermark> -->
+    <!-- <watermark scale="0.5">DRAFT</watermark> -->
   </common>
 
 
@@ -34,7 +34,6 @@
     <!-- See
     https://pretextbook.org/doc/guide/html/publication-file-source.html#publication-file-source-version -->
     <!-- <version include="videos labs"/> -->
-    <version include="linux-kit-client" />
   </source>
 
   <numbering>
@@ -61,7 +60,7 @@
   <!-- for printing; set @sides="two" if the printing woudl be two- -->
   <!-- sided.  @pageref="yes/no" controls whether page number are   -->
   <!-- included in cross-references                                 -->
-  <latex print="yes" sides="two" font-size="10" draft="no">
+  <latex print="no" sides="two" font-size="10" draft="no">
     <!-- Control text justification and bottom page behavior: -->
     <page right-alignment="flush" bottom-alignment="ragged" />
     <!-- Add content to \geometry{}: -->
@@ -70,7 +69,7 @@
     <!-- links the html version of asymptote graphics.    -->
     <asymptote links="no" />
     <!-- Set @formatted to "no" to remove formatting on worksheets: -->
-    <worksheets formatted="yes" />
+    <!-- <watermark scale="1.0">DRAFT</watermark> -->
   </latex>
 
   <html>