mik icon indicating copy to clipboard operation
mik copied to clipboard

Provide defaults for .ini options that are documented as "required"

Open mjordan opened this issue 7 years ago • 2 comments

[WRITER]
metadata_filename = MODS.xml

in the CSV Books and Newspapers is one example. There is no need for people to have to enter these type of options in .ini files.

mjordan avatar Mar 23 '17 22:03 mjordan

Just grepped through the wiki files for grep "Required" * | grep "Must be" and got the following list:

Toolchain:-CONTENTdm-books.md:* class: Required. Must be 'Cdm'.
Toolchain:-CONTENTdm-books.md:* record_key: Required. Must be 'pointer'.
Toolchain:-CONTENTdm-books.md:* class: Required. Must be 'mods\CdmToMods'.
Toolchain:-CONTENTdm-books.md:* class: Required. Must be 'CdmBooks'.
Toolchain:-CONTENTdm-books.md:* class: Required. Must be 'CdmBooks'.
Toolchain:-CONTENTdm-books.md:* metadata_filename: Required. Must be 'MODS.xml'.
Toolchain:-CONTENTdm-compound-PDFs.md:* class: Required. Must be 'Cdm'.
Toolchain:-CONTENTdm-compound-PDFs.md:* record_key: Required. Must be 'pointer'.
Toolchain:-CONTENTdm-compound-PDFs.md:* class: Required. Must be 'mods\CdmToMods'.
Toolchain:-CONTENTdm-compound-PDFs.md:* class: Required. Must be 'CdmPhpDocuments'.
Toolchain:-CONTENTdm-compound-PDFs.md:* class: Required. Must be 'CdmPhpDocuments'.
Toolchain:-CONTENTdm-Generic-Compound.md:* class: Required. Must be 'Cdm'.
Toolchain:-CONTENTdm-Generic-Compound.md:* record_key: Required. Must be 'pointer'.
Toolchain:-CONTENTdm-Generic-Compound.md:* class: Required. Must be 'mods\CdmToMods'.
Toolchain:-CONTENTdm-Generic-Compound.md:* class: Required. Must be 'CdmCompound'.
Toolchain:-CONTENTdm-Generic-Compound.md:* class: Required. Must be 'CdmCompound'.
Toolchain:-CONTENTdm-newspapers.md:* class: Required. Must be 'Cdm'.
Toolchain:-CONTENTdm-newspapers.md:* record_key: Required. Must be 'pointer'.
Toolchain:-CONTENTdm-newspapers.md:* class: Required. Must be 'mods\CdmToMods'.
Toolchain:-CONTENTdm-newspapers.md:* class: Required. Must be 'CdmNewspapers'.
Toolchain:-CONTENTdm-newspapers.md:* class: Required. Must be 'CdmNewspapers'.
Toolchain:-CONTENTdm-newspapers.md:* metadata_filename: Required. Must be 'MODS.xml'.
Toolchain:-CONTENTdm-single-file-objects.md:* class: Required. Must be 'Cdm'.
Toolchain:-CONTENTdm-single-file-objects.md:* record_key: Required. Must be 'pointer'.
Toolchain:-CONTENTdm-single-file-objects.md:* class: Required. Must be 'mods\CdmToMods'.
Toolchain:-CONTENTdm-single-file-objects.md:* class: Required. Must be 'CdmSingleFile'.
Toolchain:-CONTENTdm-single-file-objects.md:* class: Required. Must be 'CdmSingleFile'.
Toolchain:-CSV-books.md:* class: Required. Must be 'Csv'.
Toolchain:-CSV-books.md:* class: Required. Must be 'mods\CsvToMods'.
Toolchain:-CSV-books.md:* class: Required. Must be 'CsvBooks'.
Toolchain:-CSV-books.md:* class: Required. Must be 'CsvBooks'.
Toolchain:-CSV-books.md:* metadata_filename: Required. Must be 'MODS.xml'.
Toolchain:-CSV-compound-objects.md:* class: Required. Must be 'Csv'.
Toolchain:-CSV-compound-objects.md:* class: Required. Must be 'mods\CsvToMods'.
Toolchain:-CSV-compound-objects.md:* class: Required. Must be 'CsvCompound'.
Toolchain:-CSV-compound-objects.md:* class: Required. Must be 'CsvCompound'.
Toolchain:-CSV-compound-objects.md:* metadata_filename: Required. The name of the metadata filename. Must be 'MODS.xml'.
Toolchain:-CSV-newspapers.md:* class: Required. Must be 'Csv'.
Toolchain:-CSV-newspapers.md:* class: Required. Must be 'mods\CsvToMods'.
Toolchain:-CSV-newspapers.md:* class: Required. Must be 'CsvNewspapers'.
Toolchain:-CSV-newspapers.md:* class: Required. Must be 'CsvNewspapers'.
Toolchain:-CSV-newspapers.md:* metadata_filename: Required. Must be 'MODS.xml'.
Toolchain:-CSV-single-file-objects.md:* class: Required. Must be 'Csv'.
Toolchain:-CSV-single-file-objects.md:* class: Required. Must be 'mods\CsvToMods'.
Toolchain:-CSV-single-file-objects.md:* class: Required. Must be 'CsvSingleFile'.
Toolchain:-CSV-single-file-objects.md:* class: Required. Must be 'CsvSingleFile'.

I'll take a closer look at this list to see which ones are low hanging fruit code-wise.

mjordan avatar Mar 24 '17 17:03 mjordan

I spent 20 minutes yesterday figuring out why MIK was core dumping, and it was because I didn't have the required preserve_content_filenames option in my .ini file. Also was helping someone else via email use MIK and she had the exact same problems. I'd like to fix this one in the short term. It is used in the CsvSingleFile and CsvSingleFileJson writers. Might be good to have this one done before the workshop.

mjordan avatar Mar 27 '17 15:03 mjordan