VariableNaming

1. D O C U M E N T S T A N D A R D
2. ############### ###############
4. N A M I N G
6. Documents are stored as PDF with a filename of the format:
7. [document_md5sum].pdf
9. Document metadata is saved as a json-file with a filename of the format:
10. [document_md5sum].json
11. in the same folder as it's corresponding pdf-file.
13. Exceptions:
14. On wiki import the file is copied to the import folder with
15. a descriptive filename, as that is what the corresponding
16. wiki pages will be named.
18. On download the file is named to whatever name the file is given upon
19. download, as a checksum cannot be calculated until the file is on disk.
20. It is then imediately renamed according to the standard
22. On generation the file is named with a unique name (like parent doc + pages to include)
23. When the file has been generated, a checksum is calculated and
24. the file is renamed.
28. A T T R I B U T E S
30. Some document attributes are reserved and given a defined meaning here.
31. Other attributes can exists, but should not be passed to other programs
33. CamelCase is used due to it being used in the wiki
35. GENERAL
37. Type: [interrogation, promemoria, confrontation, letter, etc]'
38. Title: A well formatted and descriptive title that will be the base name on the wiki
39. WikiTitle: Same as above but after wiki name formatting and folding
40. Checksum: MD5 checksum of the corresponding PDF-file
41. SectionCode: A code refering to the ledger
42. InterrogationStart: Date and/or time of interrogation start or generation of document
43. InterrogationEnd: Date and/or time of interrogation end
44. Language: sv
45. Interrogator: Name of interrogator
46. Interrogated: Name of interrogated
47. ShortSummary: A short summary displayed on the wiki
48. Author: Name of person generating a document if not the interrogator
49. Progress: Stage of document in wiki-terms (e.g. proofread, waiting for OCR)
50. Notes: Notes on the document, also used for OCR errors etc
51. Stage: The stage in the import process [OCR, waiting, downloaded, etc]
52. Release: True if doc should be deleted in the next iteration
54. SPIDER
56. FoundAt: Name of the page where the download link was found
57. FoundAtURL: The URL from which the download link was found (if any)
58. DownloadURL: The URL from which the pdf was downloaded
59. DownloadURLText: Text tag from the above URL
60. DownloadDescription: A description found in association with the download URL
61. DownloadFileName: The name of the file as downloaded
63. IMPORT
65. NumberOfPages: Number of pages contained in the corresponding PDF
66. SizeHuman: PDF file size in human readable form incl units (str)
67. SizeBytes: PDF file size in bytes (int)
68. SlackDocShouldImportMsgTS: ID of #slack-message asking about import
69. SlackDocShouldImportResponseTS: ID of #slack-response asking about import
71. DERIVED
73. PDFFilename: <checksum>.pdf
74. JSONFilename: <checksum>.json
75. Directory: <base_directory>/<Stage>/
76. OCRCacheTestFile: Filename which if present should cause use of cached OCR results
77. WikiIndex: Index:<WikiTitle>
79. LOG
80. list of dict
81. log[<date>] = {text:str,...}