https://github.com/octfx/wikijournalbot

Wikiversity List update Bot
https://github.com/octfx/wikijournalbot

Last synced: 20 days ago
JSON representation

Wikiversity List update Bot

• Host: GitHub
• URL: https://github.com/octfx/wikijournalbot
• Owner: octfx
• License: gpl-3.0
• Created: 2022-03-11T17:53:55.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-08-05T09:37:27.000Z (over 2 years ago)
• Last Synced: 2024-11-02T00:08:28.269Z (2 months ago)
• Language: PHP
• Size: 160 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# WikiJournalBot

This bot can automatically list the articles of a given journal in the [WikiJournal user Group](https://en.wikiversity.org/wiki/WikiJournal_User_Group) (WikiJournal_of_X/Volume_Y_Issue_Z).

The bot retrieves all pages that transclude the `{{WikiJournalBotList}}` template.  

Based on this list, the content of each page is retrieved and the volume and issue is extracted.

Then a SPARQL query retrieves all 'scholarly_article' (P31) that are:

- published in 'WikiJournal of Medicine' (P1433 = Q24657325)

- and match the given volume (P478) and issue (P433)

Now the page content between [`{{WikiJournalBotList}}`](https://en.wikiversity.org/wiki/Template:WikiJournalBotList) and [`{{ListEnd}}`](https://en.wikiversity.org/wiki/Template:ListEnd) is replaced with the articles found in the query.

The actual rendering of the item is done by a separate template, it can be configured through the `row_template` argument.

Note: Currently only one list per page is supported.

The bot will honor the [`{{bots}}`](https://en.wikipedia.org/wiki/Template:Bots) template, with the username set in `.env`.  

The bot can be disabled by placing [`{{nobots}}`](https://en.wikipedia.org/wiki/Template:nobots) on its user page.

## Usage

Pages that should be edited by the bot need to contain two templates.  

The beginning of a list is denoted by the `{{WikiJournalBotList}}` template, it takes the following arguments:

- `journal` (required when journal is not set in the page title)

  - The journal name to use to find the journal QID to use in the SPARQL query

- `volume` (required when volume is not set in the page title)

  - The volume number to use in the SPARQL query

- `issue` (required when issue is not set in the page title)

    - The issue number to use in the SPARQL query

- `row_template`

  - The template to use for all found articles

  - The WikiData ID is set as the `Q` argument

The SPARQL query automatically fetches an available image set in P18 and sets it as `image=File.ending` in the template

defined in `row_template`.

## Installation

Head over to [OAuthConsumerRegistration](https://meta.wikimedia.org/wiki/Special:OAuthConsumerRegistration/propose) and register a consumer only OAuth 1.0 application.  

Check: `This consumer is for use only by XXX.`  

Applicable project: `enwikiversity`  

Required grants: `Edit existing pages`  

Copy `.env.example` to `.env` and set the four keys you've got after the consumer proposition.  

Set `ARTICLE_VOLUME_LIST_TEMPLATE` in `.env` to the template that is used on pages that should have automatic bot updates.  

Set `LIST_END_TEMPLATE` in `.env` to the template that denotes the end of the list.

Run `composer install --no-dev` in the folder where `.env` resides.  

Run `php bot.php updateArticleLists` to start the update process.  

Add a cronjob to schedule updating the lists periodically

```

# Runs every monday on 06:00

0 6 * * 1 jsub -N WikiJournalListUpdate -quiet php bot.php updateArticleLists

```