User:Diegodlh/Web2Cit/Task list

Task list for Web2Cit Rapid Fund grant proposal

This is a list of tasks selected from currently open Web2Cit tasks to enhance Web2Cit usability, maintainability and community engagement.

A time estimate in hours has been provided for each task. This includes task research, implementation, documentation and communication time.

Main tasks

Goal	Objective	Task ID	Task title	Priority	Hours	Comments	Done
Collaborative maintenance	Prevent common config errors	T337131	Consider deleting the "/" on path field	High	1		Y
		T408860	Consider combining templates.json and tests.json into a single paths.json configuration file	High	12		Y
		T408861	Count number or percentage of output fields or paths for which no expectations have been set	High	6		Y
	Monitor results improvements	T317977	Add a link to server's translation summary from Web2Cit monitor result pages	High	1	Community support	Y
		T329573	Changes to Web2Cit monitor result pages do not trigger email notifications	High	3	Community support. Blocked by T379149. Alternative provided.	Partly done
		T322856	Consider showing config file revision timestamp instead of revid	Low	2		Y
		T316536	Resolve since column	High	1		Y
		T312110	Web2Cit score should handle equivalent language field values	Low	6
	Monitor bug fixes	T322885	Pipe character "|" inside a field output should be escaped on Web2Cit monitor result pages	High	1		Y
		T324776	Path/score summary table update error in some test result pages	High	2		Y Also removed leading # from path value
Usability	User script bug fixes	T347273	Cannot access translation summary page from citation dialog if no Web2Cit citation returned	Low	8	Community support on Phab	Y
		T328442	Credit label not shown when main citation source is "citoid"	High	4		Y
		T310656	Credit label update deferred if only Web2Cit citation available (no Citoid citation)	High	1	Community support on Phab	Y
		T308323	Web2Cit enable/disable checkbox stops working after switching between visual and code editing	High	4		Y
	Configuration simplicity	T317448	Consider returning a result even if the fallback template does not apply	High	4		Y
		T317168	Automatically add fallback procedure on new template field or default to fallback template on new template added	High	4		Y
		T320771	Consider offering a way to create config file redirects	Low	5	Community support
		T317441	Errors during translation should be caught and included in the template output	High	6
		T305571	Configure JsonConfig for pattern Web2Cit/data/**/*.json in metawiki's "Main" namespace	High	8		In progress
Community engagement	Collaborative translations	T408866	Re-enable collaborative translations via Translatewiki	High	2		Y
		T321606	Support translation of Web2Cit monitor templates	Low	8		Y
		T316951	Internationalize and translate the Web2Cit JSON editor	Low	10		Y
	Leverage research results	T329745	Share a table of URLs for which automatic tests have been uploaded	High	1
Maintainabiliy	Usage stats	T321568	Consider adding a comment to the citation template noting that it was filled in with Web2Cit data	High	6		Y
		T302696	Add logging middleware	High	8		Y
	Reliability	T408867	Make Web2Cit Server serve json-editor internally to Web2Cit JSON Editor	Low	2
New features	Community requests	T309869	Support wikilinks in Web2Cit citation fields	High	4	Community support on Phab	Y
		T322601	Support HTTP only websites	High	8	Community support
		T302691	Implement "replace" transformation step	High	3	Community support	Y
		T305898	Range selection transformation should support negative indices	High	2	Community support: 1, 2	Y
		T302692	Implement a "case" transformation step	High	4	Community support	Y
	Useful additions	T304326	Implement URL selection step	High	4	Community support	Y
Other bug fixes	General bugs	T322875	Web2Cit server internal error on paths with components beginning with a dot	High	2		Y
		T392381	Range transformation seems to ignore itemwise parameter setting	High	4	Community support	Y
		T347508	Server seems to crash when citoid=true and Citoid fails (and one template available)	High	4		Y
	Site bugs	T408870	Web2Cit not working with washingtonpost.com	High	3		Y
		T408871	Web2Cit not working with nytimes.com	High	3	Could not reproduce	Y
		T373280	Preq parses websites in html which claim to be in json as json, which causes a syntax error in citoid	Low	4
Developer engagement	Development workflow	T408865	Enable Continuous Integration (CI) for Web2Cit Server	Low	3		Y

Optional tasks

The following list of optional tasks have been supported by the community but they would require a bigger effort and I'm not sure about their benefit-to-cost ratio at the moment. I'm listing them here to address them in case the time taken to address the main tasks above is lower than expected:

Task ID	Task title	Comments
T302019	Consider revising the fallback translation approach
T408862	Consider supporting all Citoid/Zotero fields	Community support: 1, 2, 3
T305886	Consider implementing "community" transformation steps	Community support

Additional tasks

Tasks not planned originally, such as bugs found while working on one of the main tasks above.

Task ID	Task title	Comments	Done
T417221	Serve user script code directly from Gitlab	Declined (see task comments)	N
T317384	Consider sorting paths and fields alphabetically to avoid unwanted notifications	Nice to have	Y
T321093	Web2Cit monitor should accept empty targets array		Y
T390791	Consider using api-user-agent header for requests from Web2Cit user script	Nice to have with T302696	Y
T430885	Re-consider including URL fragment as part of URL path	Nice to have with T304326	Y
T432670	Prevent Web2Cit from being used as third-party API passthrough	Potential flaw found during development	Partly done