ūüá¨ūüáß PID manager

Home » <span title="ūüá¨ūüáß PID manager"> ūüá¨ūüáß PID manager

ūüáęūüá∑ Version fran¬≠√ßaise

Source : Twitter / CC BY

This page is for web desi­gners (inclu­ding myself) eager to dis­co­ver (or remem­ber) the design of this web­site with res­pect to Persistent IDentifiers (PID lien:o5wn).

PID is a concept worked out by mana¬≠gers of repo¬≠si¬≠to¬≠ries for the long-term pre¬≠ser¬≠va¬≠tion of digi¬≠tal docu¬≠ments. A well-known example in aca¬≠de¬≠mic circles is the ‚ÄúDOI‚ÄĚ (Digital Object Identifier) assi¬≠gned to every publi¬≠ca¬≠tion in a scien¬≠ti¬≠fic jour¬≠nal.

For ins¬≠tance, a paper listed by Frontiers in Neurology under URL
https://‚Äčwww‚Äč.fron‚Äčtier‚Äčsin‚Äč.org/‚Äča‚Äčr‚Äčt‚Äči‚Äčc‚Äčl‚Äče‚Äčs‚Äč/‚Äč1‚Äč0‚Äč.‚Äč3‚Äč3‚Äč8‚Äč9‚Äč/‚Äčf‚Äčn‚Äče‚Äču‚Äčr‚Äč.‚Äč2‚Äč0‚Äč1‚Äč8‚Äč.‚Äč0‚Äč0‚Äč9‚Äč5‚Äč2‚Äč/‚Äčf‚Äčull has been assi¬≠gned

Following link https://‚Äčdoi‚Äč.org/‚Äč1‚Äč0‚Äč.‚Äč3‚Äč3‚Äč8‚Äč9‚Äč/‚Äčf‚Äčn‚Äče‚Äču‚Äčr‚Äč.‚Äč2‚Äč0‚Äč1‚Äč8‚Äč.‚Äč0‚Äč0‚Äč952 should redi¬≠rect to the paper‚Äôs web page‚Ķ Archive mana¬≠gers are aware that the target URL is bound to vary in the long term because Internet domains and paths lea¬≠ding to docu¬≠ments are not per¬≠sistent. The advan¬≠tage of lin¬≠king via a DOI is that the regis¬≠trant (Frontiers in Neurology) takes care of main¬≠tai¬≠ning its redi¬≠rec¬≠tion to a valid loca¬≠tion. Thus, a DOI is a type of Persistent IDentifier : a long-lasting refe¬≠rence to a docu¬≠ment, file, web page, or other object (lien:o5wn).

Another type of PID regis­tra­tion used for aca­de­mic archives is the Handle system (lien:8bby). Unlike DOI, Handles are free of charge and may be set up for pro­ce­du­ral access to archi­val items in an archive.

A digi­tal object may be assi­gned seve­ral PIDs. Each one points at the object’s loca­tion or at ano­ther PID for­war­ding que­ries…


‚á™ A ‚Äėlocal‚Äô PID service

DOIs are mana¬≠ged by the DOI Foundation (lien:p7it) via a tech¬≠ni¬≠cal infra¬≠struc¬≠ture dedi¬≠ca¬≠ted to publi¬≠ca¬≠tions in aca¬≠de¬≠mic jour¬≠nals. However, it makes sense to create and manage PIDs on any domain which claims to be ‚Äėper¬≠sistent‚Äô and is used by a rela¬≠ted device. This is the case of the leti‚Äč.lt domain asso¬≠cia¬≠ted with the LeBonheurEstPossible.org web¬≠site, as both are hosted on the same account.

PID mana¬≠ger is wor¬≠king on the leti‚Äč.lt domain lis¬≠ting paths to resources cited on the web¬≠site. The core of this server is a table whose records contain the unique iden¬≠ti¬≠fier and its target URL. Every record also includes a brief des¬≠crip¬≠tion to be dis¬≠played on the title field of HTML links, and optio¬≠nally a com¬≠plete biblio¬≠gra¬≠phi¬≠cal refe¬≠rence named the content. (This voca¬≠bu¬≠lary is mine.)

PIDs on leti‚Äč.lt are 4‚ÄĎcharacter strings, for ins¬≠tance ‚Äėdyig‚Äô poin¬≠ting at the Frontiers in Neurology paper men¬≠tio¬≠ned above. Thanks to the PID resol¬≠ver, link https://‚Äčleti‚Äč.lt/‚Äčd‚Äčyig should be redi¬≠rec¬≠ted to the paper. In plain text, this is sum¬≠ma¬≠ri¬≠zed as lien:dyig or link:dyig. (The word ¬ę lien ¬Ľ means ‚Äúlink‚ÄĚ in French.)

The com¬≠plete list of PIDs is avai¬≠lable on page https://‚Äčleti‚Äč.lt/‚Äčl‚Äčist. Search for ‚Äėdyig‚Äô to find the article cited as an example.

Below are two entries in the data¬≠base, ‚Äė6ran‚Äô and ‚Äėrm0y‚Äô, the former without content and the latter with a content (tagged with a red disk ūüĒī):

Two entries in the PID database

In the left¬≠most column, expres¬≠sion (lien:6ran) can be copied and pasted to any text on a web¬≠site. It is a good idea to include paren¬≠theses so that it will not be trun¬≠ca¬≠ted. Depending on the context, PID mana¬≠ger will decide whe¬≠ther these paren¬≠theses need to be pre¬≠ser¬≠ved. Bibliographic refe¬≠rences can be more expli¬≠cit, for ins¬≠tance (Blekkenhorst L et al., 2015 lien:6ran).

The tar¬≠gets of PIDs on leti‚Äč.lt should be DOIs whe¬≠ne¬≠ver these are avai¬≠lable. Sometimes I prefer to store the (rela¬≠ti¬≠vely stable) URL of a publi¬≠ca¬≠tion when it leads to a down¬≠loa¬≠dable ver¬≠sion shared by the authors. It is also not cer¬≠tain that a DOI poin¬≠ting at a pre¬≠print will remain the same after the publi¬≠ca¬≠tion. Adding to the confu¬≠sion, archi¬≠vists some¬≠times bind a DOI to the PDF full text ins¬≠tead of the arti¬≠cle‚Äôs des¬≠crip¬≠tion, which is a bad prac¬≠tice.

A plugin Broken Link Checker takes care of signa¬≠ling obso¬≠lete target URLs. On page https://‚Äčleti‚Äč.lt/‚Äčl‚Äčist, admins have access to but¬≠tons ope¬≠ning an editor for target URLs, PID des¬≠crip¬≠tions, or even to delete a PID in a secure manner.

All links of page https://‚Äčleti‚Äč.lt/‚Äčl‚Äčist contain title fields. Therefore, drag¬≠ging the cursor over link ‚Äė6ran‚Äô dis¬≠plays its des¬≠crip¬≠tion : ‚ÄúDietary satu¬≠ra¬≠ted fat intake and athe¬≠ros¬≠cle¬≠ro¬≠tic vas¬≠cu¬≠lar disease mor¬≠ta¬≠lity in elderly women : a pros¬≠pec¬≠tive cohort study (ver¬≠sion 2019-12-19)‚ÄĚ. Unfortunately, this field is dele¬≠ted when pas¬≠ting the link to a page in the cur¬≠rent WordPress editor ‚ÄĒ unless copy/paste is done in HTML code‚Ķ PID mana¬≠ger takes care of res¬≠to¬≠ring titles on final links.

The date ‚Äú(ver¬≠sion 2019-12-19)‚ÄĚ appea¬≠ring at the end of a title is that of crea¬≠ting the PID entry.

‚á™ Creating a PID

At the bottom of page https://‚Äčleti‚Äč.lt/‚Äčl‚Äčist, a link can be cli¬≠cked to log in as an admi¬≠nis¬≠tra¬≠tor of the PID ser¬≠vice. Links will then appear lea¬≠ding to the PID crea¬≠tion page. Suppose that we need a PID for ‚ÄúJukka K. Korpela : IT and com¬≠mu¬≠ni¬≠ca¬≠tion‚ÄĚ whose URL is http://‚Äčjkor‚Äčpela‚Äč.fi/. We enter the two para¬≠me¬≠ters :

Creating a PHD
Entering para¬≠me¬≠ters to create a PID

After cli¬≠cking ‚ÄúCreate PID‚ÄĚ we see the result :

PID has been created
PID ‚Äė1pbb‚Äô has been crea¬≠ted.

Note that the target access pro¬≠to¬≠col is ‚Äėhttp‚Äô, not ‚Äėhttps‚Äô. The secure pro¬≠to¬≠col ‚Äėhttps‚Äô has become the stan¬≠dard for web¬≠sites though it may not have been imple¬≠men¬≠ted on old ones. PID mana¬≠ger tries to open the URL in both pro¬≠to¬≠cols and com¬≠pares their out¬≠comes in num¬≠bers of bytes. Whenever ‚Äėhttps‚Äô yields an equal or larger size it is recor¬≠ded in the data¬≠base. On page https://‚Äčleti‚Äč.lt/‚Äčl‚Äčist, URLs which have not yet been acces¬≠sed under ‚Äėhttps‚Äô are high¬≠ligh¬≠ted in yellow. The admi¬≠nis¬≠tra¬≠tor needs to click an ‚Äėupdate‚Äô button from time to time until the ‚Äėhttps‚Äô pro¬≠to¬≠col has been confir¬≠med.

Whatever the pro¬≠to¬≠col, PID ‚Äė1ppb‚Äô has now been crea¬≠ted for Jukka‚Äôs web¬≠site. Now, (lien:1pbb) takes us to the target site. In case the ran¬≠domly gene¬≠ra¬≠ted code sounds weird, click ‚ÄėChoose a dif¬≠ferent PID‚Äô to get a dif¬≠ferent one.

PID mana¬≠ger warns the admin in case a PID lin¬≠king to the same URL is already exis¬≠ting. An option to change the des¬≠crip¬≠tion is offe¬≠red. To achieve a sui¬≠table mat¬≠ching of iden¬≠ti¬≠cal tar¬≠gets, URLs are stan¬≠dar¬≠di¬≠zed. For ins¬≠tance, copying the URL of Wikipedia page ¬ę Cortico√Įde ¬Ľ makes it appear as :

But PID mana¬≠ger will store it as :
which is equi­va­lent and easier to read. This case occurs with every URL contai­ning Unicode cha­rac­ters out­side the English alpha­bet.

In addi¬≠tion, PID mana¬≠ger may cut out the end of a URL at the point it is no longer signi¬≠fi¬≠cant. This is the case with pages ending up with ‚Äė?utm¬≠source=‚Ķ‚Äô or ‚Äė?fbclid=‚Ķ‚Äô ‚ÄĒ both allo¬≠wing the site owner to trace whoe¬≠ver acces¬≠sed their page !

‚á™ Running PID manager

After being iden¬≠ti¬≠fied as an admin on the PID server, access is gran¬≠ted to the list of posts/pages with a few actio¬≠nable but¬≠tons :

  • ‚ÄúAdd URL‚ÄĚ will add to the list a page/post of the web¬≠site ;
  • ‚ÄúDelete‚ÄĚ will sup¬≠press a page/post from the list ;
  • ‚ÄúRun PID mana¬≠ger‚ÄĚ will launch PID Manager on the page/post.
PID mana¬≠ger : List of posts/pages

No para¬≠me¬≠ter needs to be set for run¬≠ning PID mana¬≠ger as all options have already been writ¬≠ten on the page (read below). Click ‚ÄúRun PID mana¬≠ger‚ÄĚ close to the page that needs to be pro¬≠ces¬≠sed :

Running PID mana¬≠ger on the ‚Äúdetoxi¬≠na¬≠tion‚ÄĚ page

After run¬≠ning, PID mana¬≠ger dis¬≠plays the pro¬≠ces¬≠sed page on a new window and returns to the list of post/pages. An ‚ÄúUndo‚ÄĚ button has been crea¬≠ted, making it pos¬≠sible to cancel the whole ope¬≠ra¬≠tion.

After run­ning PID mana­ger

Note that PID mana¬≠ger works on pages and posts com¬≠pliant with the cur¬≠rent WordPress editor (Gutenberg). Warnings are dis¬≠played on attempts to run it on a Classic design.

‚á™ Basic operation

Two types of text docu¬≠ments may be publi¬≠shed on WordPress web¬≠sites, namely pages and posts. The dif¬≠fe¬≠rence lies in clas¬≠si¬≠fi¬≠ca¬≠tion sys¬≠tems. Posts use cate¬≠go¬≠ries and tend to be listed in a chro¬≠no¬≠lo¬≠gi¬≠cal order, whe¬≠reas pages are sup¬≠po¬≠sed to be per¬≠ma¬≠nent. These points bear no rele¬≠vance to PID mana¬≠ger as it only takes care of the content of the page or post. In what fol¬≠lows, the word ‚Äúpage‚ÄĚ is used to desi¬≠gnate either type.

Effect of run­ning PID mana­ger for the first time

Displaying PIDs in the body of a text makes rea¬≠ding a bit unplea¬≠sant, as shown on the left side of the pic¬≠ture above. This was an incen¬≠tive to imple¬≠ment PID mana¬≠ger which ren¬≠ders shor¬≠ter links in the form of foot¬≠note calls.

Let us take for ins¬≠tance the sen¬≠tence :

There is an esca¬≠la¬≠ting debate over the value and vali¬≠dity of memory-based die¬≠tary assess¬≠ment methods (Archer E et al., 2018 lien:5ys0).

After being pro¬≠ces¬≠sed by PID mana¬≠ger, it will read :

There is an esca¬≠la¬≠ting debate over the value and vali¬≠dity of memory-based die¬≠tary assess¬≠ment methods (Archer E et al., 2018N6).

This pro¬≠cess takes care of (pre¬≠su¬≠ma¬≠bly) all syn¬≠tac¬≠tic variants, deci¬≠ding to keep or remove paren¬≠theses, and where super¬≠script is appro¬≠priate for a com¬≠pact and com¬≠pre¬≠hen¬≠sive occur¬≠rence of the PID in its context. Mixed levels are some¬≠times requi¬≠red, such as for ins¬≠tance :

Une autre patho¬≠lo¬≠gie qui n‚Äôest pas abor¬≠d√©e dans cet article est l‚Äôan√©¬≠vrisme (N8 ; vid√©oN9).

French typo¬≠gra¬≠phy is not bound by the conven¬≠tion of Modern Language Association (lien:9t7t) sta¬≠ting that super¬≠script num¬≠bers within the text should be placed out¬≠side any punc¬≠tua¬≠tion that might be present. This conven¬≠tion is fol¬≠lo¬≠wed by PID mana¬≠ger as an option for English text. A mul¬≠ti¬≠lin¬≠gual ver¬≠sion is under study.

It is pos¬≠sible to run PID mana¬≠ger seve¬≠ral time on the same page. No change will occur unless its content has been modi¬≠fied. Formally if we call f the func¬≠tion of PID mana¬≠ger, we can write : f ‚óč f = f

‚á™ Uncategorized links (notes)

By default, foot¬≠note calls are label¬≠led N1, N2 etc. and listed at the bottom of the page along with their des¬≠crip¬≠tions. See for example the bottom of page Vivre bien et longtemps. Let us convene that ‚ÄėN‚Äô means ‚Äėnote‚Äô. These links are unca¬≠te¬≠go¬≠ri¬≠zed. Different labe¬≠lings such as A1‚Ķ, B1‚Ķ etc. are used in spe¬≠ci¬≠fic contexts (read below).

If you don‚Äôt want to dis¬≠play the list as foot¬≠notes, type _no_footnotes at the end of the page. This ins¬≠truc¬≠tion will be picked up by PID mana¬≠ger and saved for fur¬≠ther use as an invi¬≠sible phrase : <div id=‚Äú_no_footnotes‚ÄĚ></div>. The phrase remains visible in the WordPress editor and can be dele¬≠ted. A page without foot¬≠notes is for ins¬≠tance Covid-19 ‚ÄĒ ressources.

Links for¬≠mat¬≠ted by PID mana¬≠ger are user-friendly : they dis¬≠play their des¬≠crip¬≠tions on ‚Äúmouse-over‚ÄĚ (the title fields of HTML links) and a new window is opened on cli¬≠cking the link :

Clicking link opens its target in a specific window
Clicking link ‚ÄėN186‚Äô opened its target in a spe¬≠ci¬≠fic window

Opening new win­dows will work even with brow­sers set up to blo­cking pop-ups.

‚á™ Categorized links (bibliographic entries)

Web pages should contain expli¬≠cit biblio¬≠gra¬≠phic entries rea¬≠dable on paper prints. This is the case with page Soigner ses art√®res. Entries have been ini¬≠tially edited as fol¬≠lows :

Bibliographic entries, source

After being pro¬≠ces¬≠sed by PID mana¬≠ger they appear as :

Bibliographic entries, processed

In this pro¬≠cess, foot¬≠note calls ‚ÄėA1‚Äô and ‚ÄėA2‚Äô have been crea¬≠ted which are dis¬≠tinct from ‚ÄėN1‚Äô, ‚ÄėN2‚Äô etc.

In the body of the text, all calls pre¬≠viously label¬≠led lien:exjf have been repla¬≠ced with A1, gene¬≠rally dis¬≠played in super¬≠script. Moving the mouse over ‚ÄėA1‚Äô dis¬≠plays the des¬≠crip¬≠tion (title field) and cli¬≠cking it opens a window contai¬≠ning its target.

The ‚Äė‚úď‚Äô sign close to the H2, H3 or H4 header tag of a biblio¬≠gra¬≠phic list (i.e. <h2>‚úď or <h3>‚úď or <h4>‚úď) tells PID mana¬≠ger that the list should be cate¬≠go¬≠ri¬≠zed.

‚ě° The ‚Äė‚úď‚Äô sign is a Unicode cha¬≠rac¬≠ter, not a glyph. You may ignore the ‚Äė‚ᙂÄô sign, an optio¬≠nal link jum¬≠ping back to the table of contents.

PID mana­ger does not only reshape foot­note calls and entries. It also stores the full entry (the content) into the PID data­base. It reads the entry in the biblio­gra­phy and com­pares its length with both the des­crip­tion and any content already saved in the data­base. The lon­gest content is saved if it is dif­ferent from the des­crip­tion.

Conversely, the content stored in the data¬≠base will be copied to the biblio¬≠gra¬≠phic entry if it is longer than the cur¬≠rent entry. This can be used to construct biblio¬≠gra¬≠phies in a very quick way. For ins¬≠tance, just type :

After run¬≠ning PID mana¬≠ger we get full entries because the contents of ‚Äėexjf‚Äô and ‚Äė3a5m‚Äô had already been stored in the data¬≠base :

  • A1 ¬∑ exjf ¬∑ Alehagen, U et al. (2015). Reduced Cardiovascular Mortality 10 Years after Supplementation with Selenium and Coenzyme Q10 for Four Years : Follow-Up Results of a Prospective Randomized Double-Blind Placebo-Controlled Trial in Elderly Citizens. PLOS (on line).
  • A2 ¬∑ 3a5m ¬∑ Allan, NJR (1990). Household Food Supply in Hunza Valley, Pakistan. Geographical Review 80, 4, Oct.: 399‚Äď415.

Note that the gar¬≠bage text writ¬≠ten after ‚Äúlien:3a5m‚ÄĚ on this demo should be shor¬≠ter than the des¬≠crip¬≠tion of PID ‚Äė3a5m‚Äô, other¬≠wise it would be picked up and stored as a new content.

You can create seve¬≠ral biblio¬≠gra¬≠phi¬≠cal lists on the same page for dif¬≠ferent cate¬≠go¬≠ries of publi¬≠ca¬≠tions. For ins¬≠tance, on page Statines et m√©dicaments anticholest√©rol there are 3 cate¬≠go¬≠ries of publi¬≠ca¬≠tions assi¬≠gned pre¬≠fixes A, B and C. You may use ‚ÄėA‚Äô for ‚Äėarticles‚Äô and ‚ÄėB‚Äô for ‚Äėbooks‚Äô‚Ķ Since ‚ÄėN‚Äô is reser¬≠ved to unca¬≠te¬≠go¬≠ri¬≠zed PID entries, please contact me if you need to go beyond ‚ÄėM‚Äô!

‚á™ Alphabetic order

By default, cate¬≠go¬≠ri¬≠zed biblio¬≠gra¬≠phic entries are kept in the order they have been ente¬≠red. There is an option for alpha¬≠be¬≠tic sor¬≠ting a biblio¬≠gra¬≠phi¬≠cal list. An example of sorted entries is page Pourquoi diminuer le cholest√©rol ?. Conversely, entries had been sorted chro¬≠no¬≠lo¬≠gi¬≠cally in Faut-il jeter les enqu√™tes nutritionnelles ? and PID mana¬≠ger did not change their order.

To acti¬≠vate this option, type ‚Äú_alpha‚ÄĚ in the hea¬≠ders of blocks contai¬≠ning cate¬≠go¬≠ri¬≠zed biblio¬≠gra¬≠phic entries that need to be sorted alpha¬≠be¬≠ti¬≠cally, for ins¬≠tance :

<h2>‚úď Ouvrages _alpha

This ins¬≠truc¬≠tion will be read by PID mana¬≠ger and saved for fur¬≠ther use as an invi¬≠sible phrase such as <div id=‚Äú_alphabetic_order_1‚ÄĚ></div>. This phrase remains visible as a HTML block in the Gutenberg editor and can be dele¬≠ted.

‚á™ Shared bibliography

Bibliographic entries crea¬≠ted on a page are auto¬≠ma¬≠ti¬≠cally repro¬≠du¬≠ced as unca¬≠te¬≠go¬≠ri¬≠zed links (notes) in other pages men¬≠tio¬≠ning the same PIDs.

Look for ins¬≠tance at page Cancer - conclusion et r√©f√©rences which contains all refe¬≠rences cited on seve¬≠ral rela¬≠ted pages. This page contains the fol¬≠lo¬≠wing refe¬≠rence :

  • A8 ¬∑ sfm0 ¬∑ Blasco, MT et al. (2019). Complete Regression of Advanced Pancreatic Ductal Adenocarcinomas upon Combined Inhibition of EGFR and C‚ÄĎRAF. Cancer Cell, 35, 4 : 573‚Äď587. doi:10.1016/j.ccell.2019.03.002.

A call to PID sfm0 is found on page Cancer - nouvelles pistes and label¬≠led ‚ÄėN106‚Äô. PID mana¬≠ger repro¬≠du¬≠ced this entry exactly at the bottom of the page :

  • N106 ¬∑ sfm0 ¬∑ Blasco, MT et al. (2019). Complete Regression of Advanced Pancreatic Ductal Adenocarcinomas upon Combined Inhibition of EGFR and C‚ÄĎRAF. Cancer Cell, 35, 4 : 573‚Äď587. doi:10.1016/j.ccell.2019.03.002.

These biblio¬≠gra¬≠phic entries may be copied by hand on the same page to construct lists of cate¬≠go¬≠ri¬≠zed links for articles (A), books (B) etc. These will be optio¬≠nally sorted alpha¬≠be¬≠ti¬≠cally. Once an entry is listed as a cate¬≠go¬≠ri¬≠zed link, PID mana¬≠ger no longer includes it as unca¬≠te¬≠go¬≠ri¬≠zed (N) ‚ÄĒ dupli¬≠ca¬≠ting foot¬≠notes would be ugly‚Ķ

The contents of these entries are syn­chro­ni­zed each time PID mana­ger is run on the pages on which they are dis­played.

‚á™ Cleaning-up references

By default, PID mana¬≠ger cleans up refe¬≠rences. Every cate¬≠go¬≠ri¬≠zed link (biblio¬≠gra¬≠phic entry) is dis¬≠played as stri¬≠ke¬≠through text if it does not appear in the text of the page. For ins¬≠tance :

Striked biblio­gra­phic entries

To deac¬≠ti¬≠vate this clean-up, enter ‚Äú_no_strike‚ÄĚ anyw¬≠here on the page. This ins¬≠truc¬≠tion will be picked up by PID mana¬≠ger and saved for fur¬≠ther use as an invi¬≠sible phrase : <div id=‚Äú_no_strike‚ÄĚ></div>. The phrase remains visible in the WordPress editor and can be dele¬≠ted.

‚á™ Cuttting-out labels

Labels on the list of cate¬≠go¬≠ri¬≠zed links may be igno¬≠red, nota¬≠bly when entries are not found in the text of the page. This will yield the fol¬≠lo¬≠wing :

Categorized links without labels

To remove labels, enter ‚Äú_no_label‚ÄĚ anyw¬≠here on the page. This ins¬≠truc¬≠tion will be picked up by PID mana¬≠ger and saved for fur¬≠ther use as an invi¬≠sible phrase : <div id=‚Äú_no_label‚ÄĚ></div>. The phrase remains visible in the WordPress editor and can be dele¬≠ted.

‚á™ No recode + secure recovering of pages

Some pages/posts may not be eli¬≠gible for being pro¬≠ces¬≠sed by PID mana¬≠ger. This one for ins¬≠tance. In order to pro¬≠tect them against unwan¬≠ted use of the pro¬≠ce¬≠dure, type ‚Äú_no_recode‚ÄĚ anyw¬≠here on the page. This ins¬≠truc¬≠tion will be read by PID mana¬≠ger and saved for fur¬≠ther use as an invi¬≠sible phrase : <div id=‚Äú_no_recode‚ÄĚ></div>.

PID mana¬≠ger modi¬≠fies the text content of a page in WordPress without crea¬≠ting a new ver¬≠sion in the WordPress data¬≠base. It does not even modify its date of last saving. This means that if the page has been mis¬≠ta¬≠kenly pro¬≠ces¬≠sed it cannot be reco¬≠ve¬≠red in the WordPress envi¬≠ron¬≠ment. Fortunately, the pro¬≠gram stores a backup of its ori¬≠gi¬≠nal ver¬≠sion as a text file that can be retrie¬≠ved simply by cli¬≠cking the ‚ÄúUndo‚ÄĚ button.

Be care¬≠ful that backups are over¬≠writ¬≠ten each time a page is pro¬≠ces¬≠sed. It is the¬≠re¬≠fore safe to check that the pro¬≠cess has done what was expec¬≠ted. Even safer, keep the page opened in edit mode while applying PID mana¬≠ger. If the result is not satis¬≠fac¬≠tory, cli¬≠cking the ‚ÄúUpdate‚ÄĚ button in the editor will return to the pre-processing ver¬≠sion.

‚á™ Table of contents

This site constructs tables of contents using the designer-friendly plugin CM Table Of Contents Pro. This page is an example of the pro¬≠cess. The plugin builds dyna¬≠mi¬≠cally a table of contents based on the hie¬≠rar¬≠chy of <h1>, <h2>, <h3> tags. A spe¬≠ci¬≠fic marker [cmtoc_‚Ķ] needs to be placed in the text at the very loca¬≠tion the table of contents will be dis¬≠played.

PID mana¬≠ger looks for the [cmtoc_‚Ķ] marker and per¬≠forms two changes :

  1. It inserts a ‚ÄúSommaire‚ÄĚ line above the table of content with anchor id=‚Äútoc‚ÄĚ. This id is used both for retur¬≠ning to the ‚ÄúSommaire‚ÄĚ loca¬≠tion and for¬≠mat¬≠ting this word via the ‚Äútoc‚ÄĚ iden¬≠ti¬≠fier in CSS.
  2. It inserts an up-arrow (⇪) at the begin­ning of every <h…> header lin­king back to the table of contents.

This table of contents fea¬≠ture is optio¬≠nal : PID mana¬≠ger only does this if the [cmtoc_‚Ķ] marker has been found in the page.

‚á™ Syntax of footnote calls

In most cases, foot¬≠note calls appear as single occur¬≠rences in a simple syntax, e.g.:

There is an esca¬≠la¬≠ting debate over the value and vali¬≠dity of memory-based die¬≠tary assess¬≠ment methods (Archer E et al., 2018 lien:5ys0).

However, mul¬≠tiple calls may occur, for ins¬≠tance :

There is an esca¬≠la¬≠ting debate over the value and vali¬≠dity of memory-based die¬≠tary assess¬≠ment methods (Archer E et al., 2018 lien:5ys0, lien:yhcg ; Young SS, Karr A, 2011 lien:5ep8).

After being pro¬≠ces¬≠sed by PID mana¬≠ger this sen¬≠tence will be dis¬≠played as :

There is an esca¬≠la¬≠ting debate over the value and vali¬≠dity of memory-based die¬≠tary assess¬≠ment methods (Archer E et al., 2018N9¬∑N13 ; Young SS, Karr A, 2011N14).

Multiple entries are grou­ped when linked by commas or spaces, such as

Voir Archer, E et al. (2018 lien:54ji, lien:aw3j, lien:cm76 ; 2017 lien:nxg2 ou encore 2015 lien:f4st lien:ohn3 lien:s9ks).

yiel¬≠ding :

Voir Archer, E et al. (2018N13¬∑N14¬∑N15 ; 2017N16 ou encore 2015N17¬∑N18¬∑N19).

Many syn¬≠tac¬≠tic variants of mul¬≠tiple biblio¬≠gra¬≠phic calls are pro¬≠ces¬≠sed by PID mana¬≠ger, and a few mis¬≠takes such as an unwan¬≠ted clo¬≠sing paren¬≠the¬≠sis may be auto¬≠ma¬≠ti¬≠cally fixed. More cases will be inclu¬≠ded in the imple¬≠men¬≠ta¬≠tion whe¬≠ne¬≠ver pos¬≠sible.

Faulty closing quote produced by WP-Typography
Faulty clo­sing quote pro­du­ced by WP-Typography

PID mana¬≠ger is not meant to fix typo¬≠gra¬≠phy. Still, it does its best to pre¬≠pare the text for an auto¬≠ma¬≠tic typo¬≠gra¬≠phy plugin such as WP-Typography. For ins¬≠tance, in the cur¬≠rent ver¬≠sion (May 2020) WP-Typography misses a clo¬≠sing quote in French typo¬≠gra¬≠phy when fol¬≠lo¬≠wed with a super¬≠script (see above image).

Typography fixed by PID manager
Typography fixed by PID mana­ger

PID mana¬≠ger anti¬≠ci¬≠pates the pro¬≠blem and inserts requi¬≠red code for a cor¬≠rect pro¬≠ces¬≠sing (see side image).

PID mana¬≠ger replaces all no-break spaces ‚Äė&nbsp ;‚Äô with stan¬≠dard spaces in the body of the text. Then it recreates the ones fol¬≠lo¬≠wing digits ‚ÄĒ such as ¬ę 10_000 ¬Ľ or ¬ę 3_meters ¬Ľ. No-break spaces asso¬≠cia¬≠ted (in French) with some punc¬≠tua¬≠tion signs or inside French ¬ę quotes ¬Ľ are recons¬≠truc¬≠ted by WP-Typography.

Many other ‚Äėfixes‚Äô can be imple¬≠men¬≠ted in PID mana¬≠ger while being care¬≠ful not to mess up page contents in future ver¬≠sions of WordPress and wid¬≠gets handles by the Gutenberg editor.

An attempt to use narrow no-break space ‚Äė&#8239 ;‚Äô in repla¬≠ce¬≠ment of ‚Äė&nbsp ;‚Äô has been aban¬≠do¬≠ned because this cha¬≠rac¬≠ter is not (yet?) reco¬≠gni¬≠zed by Safari. It is also an option of WP-typography.

‚á™ Security

It is clear that secu¬≠rity pro¬≠ce¬≠dures imple¬≠men¬≠ted in WordPress or added as plu¬≠gins may not agree with modi¬≠fi¬≠ca¬≠tions of the data¬≠base done by a ‚Äúforeign‚ÄĚ script. In order to work PID mana¬≠ger pro¬≠perly it may be neces¬≠sary to add excep¬≠tions to the pro¬≠tec¬≠tion system, for ins¬≠tance append the IP range of your DSL box to the white list of the pro¬≠tec¬≠tion device.

‚á™ Current limitations

At present, PID mana¬≠ger modi¬≠fies the fol¬≠lo¬≠wing HTML code :

  1. <i> tags are repla­ced with <em>
  2. <b> tags are repla­ced with <strong>
  3. Some no-break spaces ‚Äė&nbsp ;‚Äô may be repla¬≠ced with stan¬≠dard spaces (read above)
  4. Strings of spaces are repla¬≠ced with a single space
  5. <span> ins­truc­tions inside hea­ders are dele­ted
  6. id=‚Äú‚Ķ‚ÄĚ mar¬≠kers inside header tags H1, H2 etc. are dele¬≠ted

The first two ope­ra­tions are stan­dard in the WordPress editor. Multiple spaces are redu­ced to single space by WP-Typography.

⇪ To conclude…

Dealing with PIDs was my domain of exper¬≠tise when wor¬≠king in the field of Digital Humanities (lien:wvdl). DH is an area of scho¬≠larly acti¬≠vity inclu¬≠ding the sys¬≠te¬≠ma¬≠tic use of digi¬≠tal resources in the huma¬≠ni¬≠ties, as well as the ana¬≠ly¬≠sis of their appli¬≠ca¬≠tion. I had taken part in a French pilot pro¬≠ject for the imple¬≠men¬≠ta¬≠tion of repo¬≠si¬≠to¬≠ries aiming at the long-term pre¬≠ser¬≠va¬≠tion and sha¬≠ring of lin¬≠guis¬≠tic resources. This was later arti¬≠cu¬≠la¬≠ted with the CLARIN and DARIAH European research infra¬≠struc¬≠tures. For these rea¬≠sons I take care in loo¬≠king for the most reliable and useful bits of infor¬≠ma¬≠tion and ensu¬≠ring a reliable access to the same.

I invite rea¬≠ders and desi¬≠gners to send sug¬≠ges¬≠tions for impro¬≠ving PID mana¬≠ger. Implementation on other sites is open to dis¬≠cus¬≠sion. Use my contact page or write a public com¬≠ment at the bottom of this page‚Ķ

Article créé le 27/04/2020 - modifié le 11/06/2020 à 14h08


√Čcrire un commentaire...

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.