search

programminghistorian / jekyll

Jekyll-based static site for The Programming Historian
http://programminghistorian.org
513 stars 229 forks source link

Whitelist of Wikipedia linked terms #1317

Closed acrymble closed 5 years ago

acrymble commented 5 years ago

related to #1209 the building of an English language stylesheet. I have put together a list of all links to Wikipedia in lessons. About half of lessons contain Wikipedia links, to what I'd generally call "technical" or "mathematical" terms. In order to ensure that our authors more consistently link these terms to Wikipedia, I think it would be worth trying to articulate which terms should be linked, and possibly finding an automated way to scan incoming lessons for these terms during the editorial process (thereby reducing editor effort required).

The questions are:

  1. is a simple whitelist (a set of terms that we check for) going to be good enough for our purposes here, while encouraging authors to also use their judgment for adding in links on terms not yet on our whitelist
  2. Is there a clear way of describing what these types of words are, so that it's less ambiguous when the wikipedia link is needed?

Here is the full list (I tried to remove links to proper names):

arojascastro commented 5 years ago

Maybe we could create a glossary with a standard definition where all lessons point to. This glossary could contain:

acrymble commented 5 years ago

@arojascastro that sounds like a lot of work.

acrymble commented 5 years ago

@mdlincoln would it be technically possible to scan lesson requests with travis to look for a list of terms to check if they are linked to Wikipedia? Or is that going to be a nightmare?

mdlincoln commented 5 years ago

At 2019-06-26 meeting, decided that the more general technical writing guidelines will advise linking technical terms to wikipedia, so a separate "whitelist" will be redundant.