Terug naar de blog

Technische documentatie offline lezen op iPad

De meeste documentatietools exporteren statische HTML. MkDocs, Sphinx, Docusaurus, Hugo, een gegenereerde API-referentie: het resultaat is een zelfstandige map, gebouwd om zonder verbinding te werken. Precies wat je nodig hebt in een vliegtuig, in de kelder van een datacenter, of bij een klant wiens wifi je laptop weigert.

Rest alleen nog hem te openen op de tablet die je meenam.

Waarom PDF niet het antwoord is

De reflex is de documentatie naar PDF te exporteren. Dat werkt, en voor een kort document is het vaak de juiste keuze. Maar technische documentatie verliest veel bij de conversie.

Terwijl de HTML-export al bestaat, en dat allemaal bevat.

De documentatie houden zoals ze gegenereerd is

Pagira opent de exportmap zoals een browser dat zou doen: de zijbalk, de links tussen pagina's, de codekleuring. Je raadpleegt de documentatie, geen foto ervan.

  1. Kopieer de exportmap naar Bestanden of iCloud Drive.
  2. Open hem met Pagira.
  3. Navigeer zoals op de site: de werkbalk geeft terug, vooruit en herladen.

iCloud Drive en de offlinevraag

Gegenereerde documentatie loopt vaak in de honderden megabytes, afbeeldingen en lettertypen inbegrepen. In iCloud Drive laadt ze terwijl je leest, zonder wachttijd voordat de eerste pagina verschijnt.

Download voor een reis een blijvende offlinekopie. De download is hervatbaar, dus een wegvallende verbinding begint niet opnieuw, en een melding maakt duidelijk wat zonder netwerk beschikbaar blijft. Zie streamen vanuit iCloud Drive of offline bewaren.

De pagina's voorbereiden die je nodig hebt

Er is offline dat je overkomt en offline dat je voorbereidt. Weet je al welke secties je gaat raadplegen, bewaar ze dan voor vertrek in de leeslijst. Elk item wordt bewaard als volledige momentopname en niet als bladwijzer, dus het blijft leesbaar ook als de bronmap verschuift. Zie de leeslijst.

Het geval van gemengde documentatie

Bedrijfsdocumentatie mengt vrijwel altijd HTML-pagina's en PDF's: een specificatie, een architectuurschema, een contractuele bijlage. Beide openen in dezelfde app, en een link van een pagina naar een PDF opent ter plekke.

Veelgestelde vragen

En documentatie van meerdere gigabytes?

Streamen vanuit iCloud voorkomt dat je alles in één keer moet downloaden. Voor volledig offline is de vrije ruimte op het apparaat de grens.

Mijn documentatie is vertrouwelijk

Er wordt niets verstuurd. Alles wordt lokaal weergegeven, en dat is juist het argument tegen een online documentviewer.

Kan ik haar ook op iPhone lezen?

Ja, één app dekt beide, en met recente items pak je een document op dat je op het andere apparaat begon.

Hoe open ik haar vanuit een andere tool?

Via het deelmenu, met Openen met Pagira, vanuit Bestanden of vanuit elke app. Zie openen vanaf overal.