Outdated version of the documentation. Find the latest one here.

Lansarea plugin-ului dvs.

O dată ce plugin-ul este gata și credeți că el ar putea fi de ajutor pentru unii utilizatori, nu ezitați să-l încărcați la Depozitul oficial al plugin-urilor python. Pe acea pagină puteți găsi instrucțiuni de împachetare și de pregătire a plugin-ului, pentru a lucra bine cu programul de instalare. Sau, în cazul în care ați dori să înființați un depozit propriu pentru plugin-uri, creați un simplu fișier XML, care va lista plugin-urile și metadatele lor, exemplu pe care îl puteți vedea în depozite pentru plugin-uri.

Vă rugăm să acordați o grijă deosebită următoarelor recomandări:

Metadate și nume

  • evitați folosirea unui nume prea asemănător cu cel al plugin-urilor existente

  • dacă plugin-ul are o funcționalitate similară cu cea a unui plugin existent, vă rugăm să explicați diferențele în câmpul Despre, astfel încât utilizatorul va ști pe care să-l folosească, fără a fi nevoie de instalare și testare

  • evitați repetarea cuvântului “plugin”, în denumirea unui plugin

  • utilizați câmpul descriere din metadate pentru o descriere de 1 linie, și câmpul Despre pentru instrucțiuni mai detaliate

  • includeți un depozit de cod, un monitor de erori, și o pagină de start; astfel, va spori considerabil posibilitatea de colaborare, aceasta făcându-se foarte ușor cu ajutorul infrastructurilor web disponibile (GitHub, GitLab, BitBucket, etc.)

  • alegeți etichetele cu grijă: evitați-le pe cele neinformative (ex: vector), preferându-le pe cele deja folosite de către alții (a se vedea site-ul plugin-urilor)

  • adăugați o pictogramă adecvată, și nu o lăsați pe cea implicită; vedeți interfața QGIS pentru o sugestie despe stilul de utilizat

Codul și ajutorul

  • nu includeți fișierul generat (ui_*.py, resources_rc.py, fișiere de ajutor generate…) și chestii inutile (ex: .gitignore) în depozit

  • adăugați pluginul în meniul corespunzător (Vector, Raster, Web, Bază de date)

  • atunci când este cazul (plugin-uri efectuând analize), luați în considerare adăugarea plugin-ului ca subplugin al cadrului de Procesare: acest lucru va permite utilizatorilor să-l rulați în lot, să-l integrați în fluxurile de lucru mai complexe, eliberându-vă de povara proiectării unei interfețe

  • includeți cel puțin documentația minimă și, dacă este util pentru testare și înțelegere, datele eșantion.

Depozitul oficial al plugin-urilor python

Puteți găsi depozitul oficial al plugin-urilor python la http://plugins.qgis.org/.

Pentru a folosi depozitul oficial, trebuie să obțineți un ID OSGEO din portalul web OSGEO.

O dată ce ați încărcat plugin-ul, acesta va fi aprobat de către un membru al personalului și veți primi o notificare.

DE EFECTUAT:

Introduceți un link către documentul guvernanței

Permisiuni

Aceste reguli au fost implementate în depozitul oficial al plugin-urilor:

  • fiecare utilizator inregistrat poate adăuga un nou plugin

  • membrii staff-ului pot aproba sau dezaproba toate versiunile plugin-ului

  • utilizatorii care au permisiunea specială plugins.can_approve au versiunile pe care le încarcă aprobate în mod automat

  • utilizatorii care au permisiunea specială plugins.can_approve pot aproba versiunile încărcate de către alții, atât timp cât aceștia sunt prezenți în lista proprietarilor de plugin-uri

  • un anumit plug-in pot fi șters și editat doar de utilizatorii staff-ului și de către proprietarii plugin-uri

  • în cazul în care un utilizator fără permisiunea plugins.can_approve încarcă o nouă versiune, versiunea plug-inului nu va fi aprobată, din start.

Managementul încrederii

Membrii personalului pot acorda încredere creatorilor de plugin-uri, bifând permisiunea plugins.can_approve în cadrul front-end-ului.

Detaliile despre plugin oferă legături directe pentru a crește încrederea în creatorul sau proprietarul.plugin-ului.

Validare

Metadatele plugin-ului sunt importate automat din pachetul arhivat și sunt validate, la încărcarea plugin-ului.

Iată câteva reguli de validare pe care ar trebui să le cunoașteți atunci când doriți să încărcați un plugin în depozitul oficial:

  1. numele folderului principal, care include plugin-ul, trebuie să conțină numai caracterele ASCII (A-Z și a-z), cifre, caractere de subliniere (_), minus (-) și, de asemenea, nu poate începe cu o cifră

  2. metadata.txt este necesar

  3. toate metadatele necesare, menționate în tabela de metadate trebuie să fie prezente

  4. the version metadata field must be unique

Structura plugin-ului

Conform regulilor de validare, pachetul compresat (.zip) al plugin-ului trebuie să aibă o structură specifică, pentru a fi validat ca plugin funcțional. Deorece plugin-ul va fi dezarhivat în interiorul directorului de plugin-uri ale utilizatorului, el trebuie să aibă propriul director în interiorul fișierului zip, pentru a nu interfera cu alte plugin-uri. Fișierele obligatorii sunt: metadata.txt și __init__.py. Totuși, ar fi frumos să existe un README și, desigur, o pictogramă care să reprezinte pluginul (resources.qrc). Iată un exemplu despre modul în care ar trebui să arate un plugin.zip.

plugin.zip
  pluginfolder/
  |-- i18n
  |   |-- translation_file_de.ts
  |-- img
  |   |-- icon.png
  |   `-- iconsource.svg
  |-- __init__.py
  |-- Makefile
  |-- metadata.txt
  |-- more_code.py
  |-- main_code.py
  |-- README
  |-- resources.qrc
  |-- resources_rc.py
  `-- ui_Qt_user_interface_file.ui