Extension:3D

Manuel des extensions MediaWiki

3D État de la version : bêta
Implémentation	Média
Description	Fournit un support des formats de fichiers 3D.
Auteur(s)	Gilles Dubuc Matthias Mullie Mark Holmquist
Dernière version	0.0.1
Politique de compatibilité	Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière.
MediaWiki	>= 1.43
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (GitHub) historique des validations (commits) contributeurs du dépôt (GitHub) relecture du code
Aide	Help:Extension:3D/fr
Paramètres $wgMax3d2pngMemory $wg3dProcessEnviron $wgAjaxPatentPreview
Accroches utilisées BeforePageDisplay UploadForm:getInitialPageText UploadFormInitDescriptor
Téléchargements trimestriels	99 (Ranked 56th)
Rôle Vagrant	three_d
Problèmes	Tâches ouvertes · Signaler un bogue

L'extension 3D permet à l'utilisateur d'un wiki de téléverser et de voir des modèles 3D. Voir Aide:Extension:3D pour la documentation d'utilisation.

Elle prend actuellement en charge le format de fichier STL, qui est commun dans l'environnement d'impression 3D.

Installation

Autoriser le téléversement des fichiers 3D

Indiquer à MediaWiki qu'il peut gérer des téléversements STL. Ajoutez ceci à votre LocalSettings.php :

$wgTrustedMediaFormats[] = 'application/sla';
$wgFileExtensions[] = 'stl';

Installer Extension:3D

• Téléchargez et placez le(s) fichier(s) dans un répertoire appelé 3D dans votre dossier extensions/.
• Ajoutez le code suivant à la fin de votre fichier LocalSettings.php  :

  wfLoadExtension( '3D' );
  

•  Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.

Installer 3d2png

3d2png est le générateur de vignettes pour les fichiers 3D. Il fournit des vignettes png de la même manière que cette extension affiche les objets, en utilisant les mêmes bibliothèques JavaScript qui s'exécutent dans Node.js au lieu du navigateur.

Pour faire l'installation, clonez et activez le dépôt 3d2png :

git clone https://gerrit.wikimedia.org/r/3d2png
cd 3d2png
npm install

Sous Linux, vous devrez installer en plus un tampon de trames virtuel pour que 3d2png (headless) puisse capturer l'objet 3D.

apt-get install xvfb

Après avoir installé 3d2png correctement, il faut indiquer à Extension:3D comment appeler ce service de génération de vignettes. Ajoutez ceci à votre LocalSettings.php, et vérifiez que les chemins sont conformes à votre configuration :

$wg3dProcessor = [
    '/usr/bin/xvfb-run',
    '-a',
    '-s',
    '-ac -screen 0 1280x1024x24',
    '/path-to-your-repository/3d2png.js'
];

Installer Extension:MultimediaViewer

MultimediaViewer n'a pas de dépendance étroite avec l'extension 3D, mais vous devez l'installer pour pouvoir interagir (déplacer, panoramique, zoom) avec les modèles 3D. Après avoir installé MultimediaViewer, vous devrez associer le type de fichier STL à l'extension correcte du visualiseur, en ajoutant ceci dans votre fichier LocalSettings.php :

$wgMediaViewerExtensions['stl'] = 'mmv.3d';

Configuration

Accord de licence

Special:Upload

Pour ajouter des options de sélection d'accord de licence à Special:Upload, modifiez la page MediaWiki:3d-patents de votre wiki. Chaque ligne de cette page sera transformée en <option>, où tout ce qui suit la dernière barre verticale | représente le texte, et tout ce qui la précède fait partie du modèle à ajouter dans le contenu téléversé. Voir commons:MediaWiki:3d-patents pour un exemple.

Assurez-vous de créer le/les modèles(s) qui seront ajoutés au contenu; par exemple Template:3dpatent

Special:UploadWizard

Special:UploadWizard prend en charge également les accords de licence, bien qu'il soit un peu moins flexible. Lorsque vous téléversez un fichier STL tiers, une fenêtre de dialogue apparaît pour que vous puissiez confirmer que votre téléversement n'enfreint pas les règles des droits d'auteur. Lorsque vous téléversez vos propres fichiers, on vous demandera également de confirmer que les objets 3D représentés sont bien le résultat de votre propre travail. Le modèle ajouté au contenu téléversé sera respectivement {{3dpatent}} ou {{3dpatent|ownwork}}.

Pour changer l'expression de ces messages, les pages suivantes peuvent être modifiées : : MediaWiki:Mwe-upwiz-patent-dialog-text-warranty et MediaWiki:Mwe-upwiz-patent-dialog-text-license.

Mettez à jour LocalSettings.php pour modifier les types de fichiers nécessitant un accord de licence, un modèle à ajouter au contenu téléversé ou vers quoi faire pointer les URLs. Vous trouverez ci-dessous les paramètres par défaut :

$wgUploadWizardConfig['patents'] = [
	'extensions' => [ 'stl' ],
	'template' => '3dpatent',
	'url' => [
		'legalcode' => '//wikimediafoundation.org/wiki/Wikimedia_3D_file_patent_license',
		'warranty' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing',
		'license' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing',
		'weapons' => '//meta.wikimedia.org/wiki/Wikilegal/3D_files_and_3D_printing#Weapons',
	],
];

Extension:CommonsMetadata

Enfin, Extension:CommonsMetadata fournit un moyen de suivre les téléversements 3D sans licence commerciale indiquée, bien que cela ne soit pas complètement configurable. Cela va simplement vérifier les téléversements qui ont un type MIME application/sla (actuellement, seuls ceux qui sont pris en charge par Extension:3D) et qui n'ont pas le modèle 3dpatent . Les fichiers correspondants qui n'ont pas ce modèle dans leur contenu seront automatiquement ajoutés dans Category:Files_with_no_machine-readable_patent.

Si vous utilisez un modèle autre que 3dpatent, cela ne vous sera pas utile car vous ne pouvez pas le configurer actuellement.