Module:Sandbox/AbstractWikipedia/Constructors

Module documentation

The Constructors module creates abstract content for the use of the NLG Scribunto prototype.

Each one of the publicly-exposed function (with the exception of the Constructors function) returns a constructor of a specific type, corresponding to the name of the function (e.g. the Birth function will return a Birth constructor). In general, the constructor will be instantiated with data from the Wikidata item corresponding to the given Q-id (an exception is the Age function which instantiates the constructor using the data given in two other constructors, namely Birth and Death). In order to facilitate access to Wikidata properties, the module uses the Wikidata module. In a Wikifunctions implementation, these constructor-creation functions would probably be user-supplied Wikifunctions functions.

The `Constructors` function

[edit ]

The Constructors function is special in that it returns a list of instantiated constructors, which correspond to the abstract content which should be verbalized for a given topic (identified by its Q-id). First, the function will attempt to retrieve manually-curated abstract content (which is stored in the Abstract Content module). If that doesn't exist, it will attempt to dynamically assemble abstract content depending to the type of the Q-id's item. Currently only items which refer to people are supported. If no abstract content can be assembled, an error is raised.

The above documentation is transcluded from Module:Sandbox/AbstractWikipedia/Constructors/doc. (edit | history)
Editors can experiment in this module’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this module.

 localp={}

 localac=require("Module:Sandbox/AbstractWikipedia/AbstractContent")
 localwd=require("Module:Sandbox/AbstractWikipedia/Wikidata")

 -- Helper function to insert information into constructor
 -- Returns true if inserted, false otherwise
 localfunctioninsertIfNotNil(constructor,field,value)
 ifvaluethen
 constructor[field]=value
 returntrue
 end
 returnfalse
 end

 -- Helper function to return a date associated with a q_id through property p_id
 localfunctiongetDate(q_id,p_id)
 localproperty=wd.getProperty(q_id,p_id,"time")
 ifnotpropertythen
 returnnil
 end
 localtime_string=property["time"]
 ifnottime_stringthenreturnnilend
 localresult={_predicate="Date",year='',month='',day=''}
 _,_,result.year,result.month,result.day=string.find(time_string,"(-?%d+)-(%d+)-(%d+)T")
 returnresult
 end

 functionp.Birth(q_id)
 localc={_predicate='Birth',person=q_id}-- Constructor to build
 localadded
 added=insertIfNotNil(c,"date",getDate(q_id,"P569"))
 added=insertIfNotNil(c,"place",wd.getItemId(q_id,"P19"))oradded
 ifaddedthen
 returnc
 end
 returnnil
 end

 functionp.Death(q_id)
 localc={_predicate='Death',person=q_id}-- Constructor to build
 localadded
 added=insertIfNotNil(c,"date",getDate(q_id,"P570"))
 added=insertIfNotNil(c,"place",wd.getItemId(q_id,"P20"))oradded
 ifaddedthen
 returnc
 end
 returnnil
 end

 -- Calculates the age of a person at the reference date in years
 functioncalculateAge(birth,reference)
 localage=tonumber(reference.year)-tonumber(birth.year)
 if(tonumber(reference.month)<tonumber(birth.month)ortonumber(reference.day)<tonumber(birth.day))then
 age=age-1
 end
 returnage
 end

 -- Returns age of person today if living, or age at death
 functionp.Age(q_id,birth,death)
 localc={_predicate="Age",person=q_id}-- Constructor to build
 ifnotbirthornotbirth.datethenreturnnilend
 ifnotdeathornotdeath.datethen
 c.age=calculateAge(birth.date,os.date("*t"))
 c.alive=true
 else
 c.age=calculateAge(birth.date,death.date)
 c.alive=false
 end
 returnc
 end


 -- Build a constructor for people
 functionp.Person(q_id)
 localc={_predicate="Person",person=q_id}-- Constructor to build
 insertIfNotNil(c,"origin",wd.getItemId(q_id,"P27"))
 insertIfNotNil(c,"occupation",wd.getItemId(q_id,"P106"))
 insertIfNotNil(c,"birth",p.Birth(q_id))
 insertIfNotNil(c,"death",p.Death(q_id))
 insertIfNotNil(c,"age",p.Age(q_id,c.birth,c.death))
 returnc
 end

 -- Returns a list of constructors appropriate for the q_id. 
 -- This is either fetched from the abstract content repository or built
 -- according to the type of the item.
 functionp.Constructors(q_id)
 ifac[q_id]then-- Check if individually curated abstract content exists
 returnac[q_id]
 elseifwd.isHuman(q_id)then
 return{p.Person(q_id)}
 end
 error("Constructors can currently support only entites which refer to people")
 end

 returnp

Retrieved from "https://meta.wikimedia.org/w/index.php?title=Module:Sandbox/AbstractWikipedia/Constructors&oldid=23956999"

The Constructors function

The `Constructors` function