Skip to content

KevinPayravi/cite-unseen

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

209 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cite Unseen

Cite Unseen is a user script that adds categorical icons to Wikipedia citations, providing readers and editors a quick initial evaluation of citations at a glance.

Full documentation can be found here: https://meta.wikimedia.org/wiki/Cite_Unseen

Usage

Cite Unseen is deployed on Meta-Wiki on the following page: https://meta.wikimedia.org/wiki/User:SuperHamster/CiteUnseen.js

See the on-wiki installation instructions for how to install this user script for yourself, either globally on Meta-Wiki or on individual language versions of Wikipedia.

Development

Cite Unseen is maintained as an npm project. Source files live under src/, and the deployable userscript is generated by the build script.

  • src/main.js handles page lifecycle orchestration.
  • src/citations/ contains citation parsing, rule matching, source data, and category data.
  • src/ui/ contains icon rendering, reflist controls, dashboards, dialogs, dialog templates, and UI-specific CSS.
  • src/i18n.js builds bundled translation data and owns language-variant conversion.
  • src/config.js loads and applies user configuration from Meta-Wiki and the local wiki.

Build requirements:

  • Node.js 22 or newer
  • npm

Install dependencies and build locally:

npm ci
npm run build

The build writes:

  • build/cite-unseen-bundled.js
  • build/README.md

Do not edit generated files in build/ by hand. Edit files under src/, i18n/, or build.js, then rebuild.

Deployment

The CI pipeline automatically builds a bundled version of the script (cite-unseen-bundled.js) and publishes it to deploy branches:

Branch Updated on Purpose
deploy Every release tag Stable production bundle
deploy-dev Every commit to main Latest development bundle
deploy-mr-## Every commit to a merge request Per-MR preview bundle (e.g. deploy-mr-42)

Note: deploy-mr-## branches contain unreviewed code from merge requests and should be tested/used with caution.

License

This project is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).

About

A user script that adds categorical icons to Wikipedia citations, providing readers and editors a quick initial evaluation of citations at a glance. MIRROR OF https://gitlab.wikimedia.org/kevinpayravi/cite-unseen

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors