[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Lydia_Pintscher]

Lydia_Pintscher updated the task description.

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Lydia_Pintscher
Cc: Addshore, RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, 
Akuckartz, apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, 
GoranSMilovanovic, Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, 
Scott_WUaS, Jonas, Wikidata-bugs, aude, Dinoguy1000, Lydia_Pintscher, Mbch331, 
Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Lydia_Pintscher]

Lydia_Pintscher added a project: Wikidata-Campsite.

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Lydia_Pintscher
Cc: Addshore, RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, 
Akuckartz, apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, 
GoranSMilovanovic, Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, 
Scott_WUaS, Jonas, Wikidata-bugs, aude, Dinoguy1000, Lydia_Pintscher, Mbch331, 
Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Reedy]

Reedy added a comment.


  Something that appears in/is linked from the API help pages, and therefore by 
design is also on Special:ApiSandbox feels more streamlined than something 
seperate and disjointed, or requires other discovery to find it.
  
  While it's extra docs to keep upto date (but I imagine it doesn't change 
often?), copy pasta of the bulk of this section (minor tweaks maybe needed?) 
into the description (seemingly `apihelp-query+wbentityusage-param-aspect` and 
`apihelp-query+wblistentityusage-param-aspect` as they both use the `Only 
return entity IDs that used this aspect.` string) would probably work best
  
Entity usage on client pages is tracked using the following codes (each 
representing one aspect):

sitelinks (S) - The entity's sitelinks are used.
label (L.xx) - The entity's label in language xx is used.
description (D.xx) - The entity's description in language xx is used.
title (T) - The title of the local page corresponding to the entity is 
used.
statements (C) - Certain statements (identified by their property id) 
from the entity are used.
other (O) - Something else about the entity is used. This currently 
implicates statement and description usage.
all (X) - All aspects of an entity are or may be used.
  
  While it would be nice if the API allowed seperate documentation of those 
list of values, it's obviously out of scope for this request, and would become 
a dependancy on being able to use it. Engineering effort suggests it's probably 
likely to end up low on a list of things to be done; but I will file a bug.
  
  The first similar example I can find in the API is for "error format`:
  
"apihelp-main-param-errorformat": "Format to use for warning and error 
text output.\n; plaintext: Wikitext with HTML tags removed and entities 
replaced.\n; wikitext: Unparsed wikitext.\n; html: HTML.\n; raw: Message key 
and parameters.\n; none: No text output, only the error codes.\n; bc: Format 
used prior to MediaWiki 1.29. errorlang and 
errorsuselocal are ignored.",
  
  Which results in something like
  
  F34485553: Screenshot 2021-06-07 at 14.38.14.png 

  
  Which obviously also makes it translateable, where a link to 
https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_usagetracking.html 
is not.

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Reedy
Cc: Addshore, RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, 
Akuckartz, apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, 
GoranSMilovanovic, Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, 
Scott_WUaS, Wikidata-bugs, aude, Dinoguy1000, Mbch331, Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Addshore]

Addshore moved this task from Inbox to Product Realm on the wdwb-tech board.
Addshore added a comment.


  They are also documented in our docs 
https://doc.wikimedia.org/Wikibase/master/php/md_docs_topics_usagetracking.html
  
  Perhaps we should just link here?
  OR has some sort of special page / help page embended in wikibase.get that 
will appear on all wikibases?

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

WORKBOARD
  https://phabricator.wikimedia.org/project/board/3532/

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Addshore
Cc: Addshore, RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, 
Akuckartz, apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, 
GoranSMilovanovic, Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, 
Scott_WUaS, Wikidata-bugs, aude, Dinoguy1000, Mbch331, Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Reedy]

Reedy added a project: wdwb-tech.

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Reedy
Cc: RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, Akuckartz, 
apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, GoranSMilovanovic, 
Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, Scott_WUaS, 
Wikidata-bugs, aude, Dinoguy1000, Addshore, Mbch331, Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Reedy]

Reedy updated the task description.

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Reedy
Cc: RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, Akuckartz, 
apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, GoranSMilovanovic, 
Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, Scott_WUaS, 
Wikidata-bugs, aude, Dinoguy1000, Mbch331, Jay8g
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org

[Wikidata-bugs] [Maniphest] T283040: prop=wbentityusage wbeuaspect values are poorly documented

[Reedy]

Reedy created this task.
Reedy added projects: MediaWiki-extensions-WikibaseClient, Wikidata, 
Documentation.
Restricted Application added a subscriber: Aklapper.

TASK DESCRIPTION
  https://en.wikipedia.org/w/api.php?action=help&modules=query%2Bwbentityusage
  
wbeuaspect

Only return entity IDs that used this aspect. 
Values (separate with | or alternative): C, D, L, O, S, T, X
  
  It's unclear what these letters mean without knowing otherwise, or digging 
into the code to find out:
  
/**
 * Usage flag indicating that the entity's sitelinks were used as links.
 * This would be the case when generating language links or sister 
links from
 * an entity's sitelinks, for display in the sidebar.
 *
 * @note: This does NOT cover sitelinks used in wikitext (e.g. via Lua).
 *Use OTHER_USAGE for that.
 */
public const SITELINK_USAGE = 'S';
/**
 * Usage flag indicating that one of the entity's labels were used.
 * This would be the case when showing the label of a referenced 
entity. Note that
 * label usage is typically tracked with a modifier specifying the 
label's language code.
 */
public const LABEL_USAGE = 'L';
/**
 * Usage flag indicating that one of the entity's descriptions were 
used.
 * This would be the case when showing the descriptions of a referenced 
entity. Note that
 * descriptions usage is typically tracked with a modifier specifying 
the language code.
 */
public const DESCRIPTION_USAGE = 'D';
/**
 * Usage flag indicating that the entity's local page name was used,
 * i.e. the title of the local (client) page linked to the entity.
 * This would be the case when linking a referenced entity to the
 * corresponding local wiki page.
 * This can be thought of as a special kind of sitelink usage,
 * specifically for the sitelink for the local wiki.
 */
public const TITLE_USAGE = 'T';
/**
 * Usage flag indicating that certain statements (identified by their 
property id)
 * from the entity were used.
 * This currently implies that we also have an OTHER_USAGE or an 
ALL_USAGE
 * for the same entity (STATEMENT_USAGE is never used alone).
 */
public const STATEMENT_USAGE = 'C';
/**
 * Usage flag indicating that any and all aspects of the entity
 * were (or may have been) used.
 */
public const ALL_USAGE = 'X';
/**
 * Usage flag indicating that some aspect of the entity was changed
 * which is not covered by any other usage flag (except "all"). That is,
 * the specific usage flags together with the "other" flag are 
equivalent
 * to the "all" flag ( S + T + L + O = X or rather O = X - S - T - L ).
 *
 * Due to migration efforts, this is currently used redundantly with
 * STATEMENT_USAGE or DESCRIPTION_USAGE, as they were only added later.
 */
public const OTHER_USAGE = 'O';
  
  Some sort of better documentation inline would be useful

TASK DETAIL
  https://phabricator.wikimedia.org/T283040

EMAIL PREFERENCES
  https://phabricator.wikimedia.org/settings/panel/emailpreferences/

To: Reedy
Cc: RBrounley_WMF, Aklapper, Reedy, Invadibot, maantietaja, Akuckartz, 
apaskulin, Nandana, lucamauri, Cpaulf30, Lahi, Gq86, GoranSMilovanovic, 
Ivana_Isadora, QZanden, LawExplorer, _jensen, rosalieper, Scott_WUaS, 
Wikidata-bugs, aude, Dinoguy1000, Mbch331, Jay8g, Quiddity
___
Wikidata-bugs mailing list -- wikidata-bugs@lists.wikimedia.org
To unsubscribe send an email to wikidata-bugs-le...@lists.wikimedia.org