Wikipedia:Lua/Modul/GlobalSharing/Registration
| Vorlagenprogrammierung | Diskussionen | Lua | Unterseiten | |||
| Modul | Deutsch | English
|
Modul: | Dokumentation | ||
Diese Seite zeigt ein Muster für die Registrierung globaler Programm-Ressourcen, wie Module, Gadgets, Vorlagen, Tools und andere.
Ein neues Datenobjekt erstellen
Bearbeiten| Typ | Beschreibung | Status | |
|---|---|---|---|
P31 ist ein(e) |
erforderlich | ||
P277 Programmiersprache |
vorgeschlagen | ||
P1324 Quelltextrepositorium |
Uniform Resource Locator | vorgeschlagen | |
P2700 verwendetes Protokoll zum Zugriff auf einen Dienst |
Q44484 Hypertext Transfer Protocol Secure | ||
P137 Organisation, die einen Service, eine Einrichtung, eine Maschine oder Gerät betreibt |
|||
P348 Version |
Versionsbezeichnung größer als die vorangehende | vorgeschlagen | |
P275 Lizenz |
vorgeschlagen | ||
P1535 verwendet von |
Bekannte Verwendungen, oder übergeordnete Einheit | optional | |
P2283 benutzt |
Abhängigkeiten, benötigte Ressourcen, aus anderen Paketen oder Untereinheiten | optional | |
P973 wird beschrieben in URL |
Uniform Resource Locator | vorgeschlagen | |
P2700 verwendetes Protokoll zum Zugriff auf einen Dienst |
Q44484 Hypertext Transfer Protocol Secure | ||
P137 Organisation, die einen Service, eine Einrichtung, eine Maschine oder Gerät betreibt |
|||
P407 zugeordnete menschliche Sprache (für Personen benutze P103 und P1412) |
|||
P366 Verwendung |
Tagging, Themen, Schlagwörter | optional | |
Notes
BearbeitenInstance of: the basic concept
Bearbeiten- The basic resource type is to be specified.
Programming language
Bearbeiten- This is pointless for non-software data like project pages.
- It is mandatory for skin resources, like JavaScript, CSS and JSON.
- On Modules this is recommended.
- It might be derived that a module is written in Lua, but might be extended by 5.1 or 6.0 language version one day.
- For other types like external tools that may be informative but does not change usability, in whatever py Tcl Java that might be implemented.
Source code repository
Bearbeiten- This is pointless for non-software data like project pages.
- It is is mandatory for source code to be copied into local wiki, like modules and perhaps templates.
- For skin resources it might be provided and may be loadable code, but is not really the safest approach to load automatically from an URL at Wikidata, the database every user in the world may edit.
- It may be some GitHub or other for external tools. It is not ensured that the executed tool is using exactly the code advertised in repository.
- If the URL is hosted by a WMF wiki this should be mentioned by qualifier.
Version identifier
Bearbeiten- This is mandatory for source code to be copied into local wiki, like modules and perhaps templates.
- In all other cases it may be informative or useless.
- For source code to be pulled or pushed a change of this value is indicating to all downstream wikis that a new release is offered for update.
- The version identification may be one of:
- major.minor.micro with digits only, etc.
- Any string, otherwise.
- A greater value must indicate a more recent version.
Licence
Bearbeiten- May be informative.
- Resources on WMF wiki pages get automatically some licensing by default.
- An author might make an explicit statement on Wikidata.
Used by
Bearbeiten- On software structures this may have two meanings:
- The root package entry of a sub unit.
- Other packages which depend on such software.
Uses
Bearbeiten- On software structures this may have two meanings:
- Inner sub units which are required or may be added optionally.
- Required or recommended other packages.
Documentation
Bearbeiten- This is pointless for non-software data like project pages.
- URL of at least one textual description of the software, not only software code itself.
- The documentation pages are supposed to provide
- General description of purpose
- Description how to install or activate
- User guide how to solve tasks
- Maintenance, background, contacting maintainers, bug reports, feature requests etc.
- For each documentation URL the human languages which are available as full translation shall be mentioned; it may be more than one on content negotiation or forking, like
Special:MyLanguage/.- The available languages can and are collected for each documentation URL, and the best match of available languages and user preference may be and is already selected.
- Any number of additional documentation URL may be added.
- The first entry is supposed to be offered by OEM.
- Any further entry might be a kind of translation and should cover at least general introduction and basic instructions on usage. For details and internals it may be referred to first entry with generic description.
- If the URL is hosted by a WMF wiki this should be mentioned by qualifier.
Tagging
Bearbeiten- Some kind of tagging is supposed for external tools.
- Currently there is no property at Wikidata for arbitrary social tagging or controlled vocabulary.
- The idea is to provide item IDs.
- When offering a tool choice, a list of all item IDs mentioned on any related software shall be presented to the user. That is presented in user language, if known, or best match. That may be used to filter a search on tools specifying particular item IDs, one of them, all of them.