Integrated manual

[jflesch]

Instead of spreading the documentation across the wiki, openpaper.work helpdesk, etc, it could be integrated as a document in Paperwork. See https://github.com/jflesch/paperwork/issues/563#issuecomment-275914415 for how to place it in the UI.

Content expected:

• [x] How to scan
  • [x] single scan (flatbed or feeder)
  • [x] from feeder
• [ ] How to import
  • [x] Image(s)
  • [x] PDF(s)
• [ ] Managing labels
• [ ] Search
  • [ ] view pages as grid
  • [ ] view pages as list
• [ ] Advanced search
• [ ] Exporting
  • [ ] document
  • [ ] page
• [ ] Printing
• [ ] Copying text (will be available in 1.2)
• [ ] Editing pages
• [ ] Moving pages
  • [ ] inside a document
  • [ ] from a document to another
• [ ] Advanced use
  • [ ] redo OCR
  • [ ] highlight all keywords
  • [ ] keyboard shortcuts (PageDown, PageUp, Ctrl+N, Ctrl+E, Ctrl+PageUp / Ctrl+PageDown, etc)
  • [ ] paperwork-shell (GNU/Linux only)
  • [ ] exporting many documents in one shot
• [ ] Getting support / reporting issues
  • [x] Diagnostic dialog
  • [ ] Github issue tracker
  • [ ] Mailing-list

[jflesch]

Hacker's guide

• [X] Ask before doing (+ open a ticket if one doesn't exist yet to indicate you're working on something)
• [X] Git branches
• [X] backend / frontend
• [X] dependencies and constraints (due to dependencies)
• [X] Jobs / Schedulers
• [X] Scan process
• [X] Documentation (Lyx power !)

Translator's guide

[jflesch]

Translator's guide: 5e44adc046934c36e6c86635172d54a25c436779

Hacker's guide, work in progress: https://github.com/jflesch/paperwork/raw/unstable/doc/hacking.pdf

[jflesch]

User manual: https://github.com/jflesch/paperwork/blob/unstable/doc/usage.pdf (WIP)

[jflesch]

The manual now contains a lot of infos, but is still not complete. However I don't think I will have time to finish it for 1.2

[jflesch]

I will remove the translator's guide and the hacker's guide. They always target the latest dev version of Paperwork ; not the one the user is currently running. They should actually be in the wiki.