Skip to content

Commit 491a7f7

Browse files
committed
Builds from source, PDF not working at present.
1 parent e4ab3ce commit 491a7f7

5 files changed

Lines changed: 22 additions & 48 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ clean:
2727

2828
# How the source is initially generated:
2929
from-gdoc:
30-
echo "Regenerating and overwriting index.md from the source DOCX file!"
30+
echo "Regenerating and overwriting index.md from the source Google Doc file!"
3131
curl -L -o source.docx "https://docs.google.com/document/u/0/export?format=docx&id=1ZfPaXMOXCphfnDKKRoImzccHtY2M2hBZLI5mP65RNpk"
3232
pandoc source.docx -o index_body.md --wrap=none -t commonmark --extract-media=.
3333
cat index_head.md index_body.md > index.md

README.md

Lines changed: 17 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,29 @@
1-
The Floppy Guide (TBC)
2-
======================
1+
Copy That Floppy!
2+
=================
33

44
As part of the [Future Nostalgia project](https://www.lib.cam.ac.uk/future-nostalgia), we are putting together a guide on preserving floppy disks. The guide is currently in the reviewing stage. The draft version of the guide can be accessed [here](https://docs.google.com/document/d/1ZfPaXMOXCphfnDKKRoImzccHtY2M2hBZLI5mP65RNpk/edit?usp=sharing). You will be able to leave any comments or suggestions.
55

66

77
Web Publication Build Process
88
-----------------------------
99

10+
The publication process is controlled by the `Makefile`, which contains all the technical details.
1011

11-
Started by downloading the source Google Document as a DOCX file. Then:
12+
- It downloads the source Google Document as a DOCX (because this brings embedded media with it)
13+
- It uses `pandoc` to convert that to Markdown + media files.
14+
- It patches in a YAML frontmatter block (`index_head.md`) to set up the document.
15+
- It uses `pandoc` to generate an ePub version.
16+
- It uses [MystMD](https://mystmd.org/guide/installing) to generate web and PDF versions.
1217

13-
```
14-
pandoc Guide\ -\ Reading\ obscure\ floppy\ disk\ formats.docx -o index.md --wrap=none -t commonmark --extract-media=.
15-
```
18+
Notes:
1619

17-
Note didn't use commonmark_x because it added anchors to the headings which MyST does not support.
20+
- Conversion didn't use commonmark_x because it added anchors to the headings which MyST does not support.
21+
- PDF generation only works if you remove styling inside hyperlinks (underlines) as this confuses Typst.
22+
- Some things, like big tables, might not convert well. These are best modified at source (GDoc).
23+
- The ePub generation process can pick up some metadata from the source document.
24+
- When developing locally, you can use `make from-gdoc serve` to rebuild and then look at the results.
1825

19-
Then had to tweak:
20-
21-
- Move some information like title and authors into structured frontmatter.
22-
- Remove styling inside hyperlinks (underlines) as this confuses Typst.
23-
- To stop the big table of controllers getting lost off the end of the page in the PDF, I had to break it up into a sequence of tables. Might work better as headings and figures.
24-
25-
26-
ePub generation:
27-
28-
```
29-
pandoc index.md -o exports/imaging-floppy-disks.epub --metadata title="A Guide To Imaging Obscure Floppy Disk Formats"
30-
```
31-
32-
But you don't need the metadata field there if you add it to the frontmatter.
33-
34-
35-
36-
MystMD setup
37-
38-
https://mystmd.org/guide/installing
39-
40-
npm install -g mystmd
41-
42-
myst start
43-
44-
45-
46-
Enable Pages
47-
48-
https://github.com/digipres/guide-to-imaging-obscure-floppies/settings/pages
49-
50-
51-
Makefile
52-
53-
54-
make from-gdoc serve
26+
Maintenance
27+
-----------
5528

29+
After the end of the Future Nostalgia project, the Digital Preservation Coalition will endeavour to ensure this publication remains available and facilitate it's ongoing maintenance and development.

index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ You can also make suggestions via [GitHub issues](https://github.com/digipres/th
4545
:::{aside}
4646
<img src="./cover.png"/>
4747
:::
48+
4849
This guide is written for practitioners wanting to image floppy disks with the intention of preserving them for the long-term. This guide will focus on floppies with a Shugart Interface, which are the 8-inch, 5.25-inch, 3.5-inch and 3-inch floppy disks. This guide will only focus on getting material from these disks and will not cover writing disks. Other resources are available for further information on floppy disks, as outlined in Section 5.
4950

5051
The guide will assume some basic knowledge on some terms, which include digital preservation and assume that you are familiar with tools such as write blockers and feel confident configuring different pieces of software, using different operating systems and the command line. Further resources on digital preservation and other basics can be found in Section 5. This guide will also not be a step-by-step demonstration of all the different tools and floppy controllers; this decision was made as the hardware and software around floppy controllers can change quite quickly. but will serve as a basis on how to get started and how to image the floppy disks in the wider sense.
@@ -81,7 +82,7 @@ As a side note, floppies, floppy disk, carriers and disks will be used interchan
8182

8283
The first step in setting up your workflow is to identify your floppy disk. There are a number of resources out there to identify the carriers in your collection, including [<u>Know you Digital Storage Media</u>](https://lib.utsa.edu/knowyourmedia/index.html) by UTSA Libraries Special Collections and [<u>The Museum of Obsolete Media</u>](https://obsoletemedia.org/). As a reminder, this guide will only be covering floppy disks with a Shugart interface, there are the 8-inch, 5.25-inch, 3.5-inch and 3-inch floppy disks. There are more types of floppy disks out there, as helpfully highlighted by [<u>the Obsolete Media museum</u>](https://obsoletemedia.org/data/floppy/), but these are not covered in this guide.
8384

84-
<img src="./media/image5.jpg" style="width:6.26772in;height:2.68056in" />
85+
<img src="./media/image4.jpg" style="width:6.26772in;height:2.68056in" />
8586

8687
*All floppy disks covered in this guide all use the Shugart Interface, from left to right: 3.5-inch floppy disk, 3-inch (Amstrad) floppy disk, 5.25-inch floppy disk and 8-inch floppy disk.*
8788

@@ -101,7 +102,7 @@ The labels of floppy disks are able to highlight a number of things:
101102

102103
- **Operating system or formatting type.** For instance, a disk might be labeled ‘DOS’ to indicate it had been formatted for IBM PC-compatible systems running MS-DOS. Others might carry labels for [<u>Macintosh (HFS)</u>](https://en.wikipedia.org/wiki/Hierarchical_File_System_(Apple)), [<u>CP/M</u>](https://en.wikipedia.org/wiki/CP/M), or other environments.
103104

104-
<img src="./media/image4.jpg" style="width:2.56771in;height:2.12022in" /><img src="./media/image6.jpg" style="width:3.59173in;height:2.16573in" />
105+
<img src="./media/image5.jpg" style="width:2.56771in;height:2.12022in" /><img src="./media/image6.jpg" style="width:3.59173in;height:2.16573in" />
105106

106107
*Different types of floppy disks. On the left is a group of 3.5-inch floppies. The two on the left being examples of DD disks, the two on the right HD disks. The picture on the left highlights a wide range of 5.25-inch floppy disks. Including DD and HD disks, all DS. The labels (if present) on these floppy disks are accurate, all disks contain data.*
107108

@@ -421,8 +422,7 @@ Examples include:
421422

422423
- [<u>Ira Goldklang’s TRS-80 Revived Site</u>](https://www.trs-80.com/wordpress/welcome/)
423424

424-
- <u>[stardot.org.uk](https://stardot.org.uk/forums/index.php)[
425-
](https://www.retrotechnology.com/)</u>
425+
- [stardot.org.uk](https://stardot.org.uk/forums/index.php)[retro](https://www.retrotechnology.com/)
426426

427427
## 5.5 Preservation and Data Recovery Decisions
428428

media/image4.jpg

-45.5 KB
Loading

media/image5.jpg

45.5 KB
Loading

0 commit comments

Comments
 (0)