Skip to content

Commit

Permalink
Day 1 notes
Browse files Browse the repository at this point in the history
  • Loading branch information
oscarlevin committed Jul 16, 2024
1 parent 6bda1bb commit 8d57667
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 2 deletions.
100 changes: 100 additions & 0 deletions Day1Notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Notes from the Moderated Problem Session

1. Worksheets:
- From a book with worksheets or activities, extract a "workbook". It might have alternate frontmatter, but it should also have links to the original source.
- Currently the activities element does not allow `@workspace`, maybe it should?
- There should also be "stand alone" worksheets.

2. "Standalone" as a way to compile a fragment, and ignore the preamble when in a large document. (Can this be managed by "versions"?). Related, an *Overlay* journal: material wrapped around a paper that appears elsewhere.

3. Worksheets as print with workspace or online interactive exercises. (Also good to print these, but online, they do not need blank space.)

4. Syllabus: What is a syllabus? Need many more tags!

5. Worksheet: what is a worksheet? e.g., Name, grade/marking

6. We need to get straight what all these things are:
- article
- worksheet
- handout
- exam
- quiz
- memo
- letter
- standalone
- laboratory
- slideshow

7. User experience: single source file document that is easy to share.

8. Landing page (this sort of exists, but it could be better).

9. Using a journal style on your latex (this could go in the publisher file). What is the `\documentclass{?}`, a journal `.sty` file. How does `\begin{theorem}` look (does it have a label?)

10. Reference/Bibliography

11. PreTeXt to JATS (Journal Article Tag Suite). It's an XML format.

12. Other conversions to/from PreTeXt. We should make a poster/diagram.

13. Cross references when extracting. Warnings are given.
- Want to make a link to the full version.
- Numbering when extracting. Preserve or renumber? Levels of numbering (figure for example). Both need to be publisher options.
- What should the reference look like? Name or number?

14. Documentation:
- Reference for intermediate users: what can go here?
- Quick start (less than 5 minutes)
- There are multiple sections of the guide that are still "todo"
- Quick start for specific document types.
- Easy to find samples (e.g. annotated book)
- More copy/paste snippets (in vscode)
- Autocomplete
- Schematic of the pretext universe
- The `pretextbook.org` landing page
- Catalog
- Interactive features (Doenet etc)
- Sample small documents to copy/modify. Maybe as templates in the CLI or in a contributed repository
- How to convert from LaTeX/Markdown

15. Community control with review. Is that separate from the current repo? What about things under development?
- Converting from latex/markdown easier than pandoc.
- Converters from "lite" languages: highlight part of a document and hit convert. Perhaps AI to go from lite documents to pretext?

16. Lite documents could be yaml and markdown, which could give you lots of pretext.
- Support people writing that.
- What subset of LaTeX converts to PreTeXt?

17. Why write in PreTeXt? Interactivity, Accessibility.

18. (an expansion of 7) One file is better (in some cases) than a directory with many files.
- Common publisher file.
- Think about the Instructor role
- "Course" content.
- Create by CLI: syllabus, worksheets.
- How to share outside a "Course" context (like sharing a `.sty` file).
- Start a document with `<publication>`.
- You can share an overleaf project.

19. Linters. Highlight sloppy markup.

20. Branding (related to "Course"). Publisher file should be Course Config file.
- Need to pay more attention to the Instructor ("Private Publishing")
- Do competitor analysis

21. Assembling legacy material (book of worksheets).

22. Dynamic Calendar: What is it?

23. Programming Languages: Which are available, what are their capabilities?

24. Other embeddables: Penrose diagrams, Lurch, Sonification for data (multimodal), large data sets (see Runestone data file object).

25. One page output (HTML including CSS & JS). Option 1: Bundle. Option 2: external CSS & JS (but this would need a better way to maintain). Zip files can be done, but don't meet the needs of this use case (sending an accessible file to a syllabus repository, eg)
- What about google fonts?
- Is ePub good enough? No, because of knowls.
- Other use cases: slides on a thumb drive

26. Put a slide in a book? Really gather all slides in one place so you can share all slides for a course in a single link, that is updated regularly. This is really like creating a "course".

27. LTI or LMS integration
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
# small-documents
For recording the work done at the Summer 2024 AIM workshop *PreTeXt for Small Documents*
# PreTeXt for Small Documents

Repository for recording the work done at the Summer 2024 AIM workshop *PreTeXt for Small Documents*.

See the Wiki and Discussion boards for most of the content.
Binary file added assets/day1_1-5.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/day1_13-14.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/day1_14-16.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/day1_17-27.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/day1_6-12.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8d57667

Please sign in to comment.