Module:Proofreadpage index template/config/sandbox

Module documentation[view] [edit] [history] [purge]

Supporting module for Module:Proofreadpage index template, which implements logic for MediaWiki:Proofreadpage index template.

The above documentation is transcluded from Module:Proofreadpage index template/config/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this module.

local c = {}

c["defaults"] = {
	Source = '_empty_',
	Progress = '_default',
	Transclusion = 'no'
}

c["headings"] = {
	title = {
		txt = 'Title',
	},
	progress = {
		txt = 'Progress',
	},
	OCLC = {
		txt = 'OCLC',
	},
    transclusion = {
    	txt = 'Transclusion',
    },
    validation_date = {
    	txt = 'Validated in',
    },
    source = {
    	txt = 'Source'
    },
    place = {
    	txt = 'Location'
    },
    year = {
    	txt = 'Year'
    },
    publisher = {
    	txt = 'Publisher'
    },
    author = {
    	txt = 'Author'
    },
    editor = {
    	txt = 'Editor'
    },
    translator = {
    	txt = 'Translator'
    },
    illustrator = {
    	txt = 'Illustrator'
    },
    DOI = {
    	txt = 'DOI'
    },
    volumes = {
    	txt = 'Volumes'
    }
}

c["status"] = {
	T = {
		cat = 'Index Validated',
		txt = 'Done—All pages of the work proper are validated',
	},
	V = {
		cat = 'Index Proofread',
		txt = 'Proofread—All pages of the work proper are proofread, but not all are validated',
	},
	C = {
		cat = 'Index Not-Proofread',
		txt = 'To be proofread',
	},
	MS = {
		cat = 'Index - Ready for Match and Split',
		txt = 'Ready for Match and Split',
	},
	OCR = {
		cat = 'Index - Text Layer Requested',
		txt = 'Source file needs an OCR text layer',
	},
	L = {
		cat = 'Index - File to fix',
		txt = 'Source file must be fixed before proofreading',
		error = true,
	},
	X = {
		cat = 'Index - File to check',
		txt = 'Create a pagelist for the source file before commencing proofreading (to verify file is correct)',
		error = true
	},
	_default = {
		cat = 'Index - Unknown progress',
		txt = 'Unknown progress (template error)',
		error = true,
	}
}

c["transclusion"] = {
	yes = {
		cat = 'Fully transcluded',
		txt = 'Fully transcluded',
		help = 'The work is fully transcluded, including front and end matter and images'
	},
	notimg = {
		cat = 'Images not fully transcluded',
		txt = 'Images not fully transcluded',
		help = 'The work is fully transcluded, but that some images are still missing or need improvement',
	},
	notadv = {
		cat = 'Advertising not transcluded',
		txt = 'Advertising not transcluded',
		help = 'The main body of the work is properly transcluded, though front- or end-matter advertising material is not'
	},
	held = {
		cat = 'Transclusion on hold',
		txt = 'Transclusion on hold',
		help = 'There is a problem with transcluding the work (which should be explained on the talk page)'
	},
	check = {
		cat = 'Transclusion check required',
		txt = 'Transclusion check required',
		help = ' The transclusion of the work is incomplete or needs checking'
	},
	no = {
		cat = 'Index not transcluded',
		txt = 'Index not transcluded or unreviewed',
		help = ' This work is not transcluded or has not been reviewed for transclusion'
	}
}

local lang_code = 'en'
local pagenamee = mw.title.getCurrentTitle():partialUrl()

c["indicators"] = {
	pagegame = {
		name = 'WS Page Game',
		image = 'File:OOjs UI icon page number.svg',
		link = mw.title.new('toolforge:ws-page-game'):fullUrl({wikisource = lang_code, lang = lang_code, index = pagenamee}),
		caption = 'Wikisource Page Game (step-by-step pagelist builder)'
	},
	purge = {
		name = 'purge file',
		image = 'File:OOjs UI icon reload.svg',
		link = mw.title.new('commons:File:' .. mw.title.getCurrentTitle().text):fullUrl({action = 'purge'}),
		caption = 'Purge file'
	},
	book2scroll = {
		name = 'book2scroll',
		image = 'File:Library-logo-blue-outline.png',
		link = mw.title.new('toolforge:book2scroll'):fullUrl({wikisource = lang_code, lang = lang_code, index = pagenamee}),
		caption = 'Open in Book2Scroll'
	},
	bookreader = {
		name = 'bookreader',
		image = 'File:BookReader-favicon.svg',
		link = mw.title.new('toolforge:bookreader/' .. lang_code .. '/' .. pagenamee):fullUrl(),
		caption = 'Open file in BookReader'
	}
}

c["url_prefixes"] = {
	OCLC = 'https://www.worldcat.org/oclc/',
	ARK = 'https://n2t.net/',
	DOI = 'https://doi.org/'
}

return c