Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Développeurs

Conversion des formats Print Designer

Retrouvez les méthodes et la page de migration qui convertissent un format Print Designer en format de l'éditeur, avec leurs règles de permission et leurs effets.

Conversion des formats Print Designer

Cette page s'adresse aux développeurs. Elle décrit les méthodes qui convertissent un format Print Designer en format de l'éditeur de la version next. Pour convertir un format dans l'interface, consultez le guide utilisateur. Pour le constructeur lui-même, consultez la référence du constructeur d'impression.

Formats Print Designer

Un format est un format Print Designer quand son champ print_designer est coché et que print_designer_print_format ou print_designer_body n'est pas vide (is_print_designer_format()).

  • Le format garde son nom quand il n'est pas standard. La conversion décoche print_designer, coche print_format_builder_beta et remplit format_data. Elle reprend aussi la police globale (font) et les marges, converties de pixels en millimètres. Les champs Print Designer restent sur l'enregistrement.
  • Un format standard appartient à son application. La conversion crée une copie nommée « nom (Editor) », non standard et non désactivée, avec converted_from rempli. Elle reporte sur la copie les défauts du type de document et les liens vers l'original, puis désactive l'original. Si la copie existe déjà, la conversion la réutilise.
  • La conversion ne modifie pas pdf_generator. Le format converti garde le moteur de l'original.
  • Les remarques de conversion sont ajoutées en commentaire du format converti.

Points d'entrée

Toutes les méthodes whitelisted appellent frappe.only_for("System Manager"), sauf indication contraire. Les méthodes de la page de migration se trouvent dans frappe.printing.page.print_designer_migration.print_designer_migration. Les autres se trouvent dans frappe.printing.doctype.print_format.print_designer_converter.

MéthodeParamètresEffet
get_print_designer_format (utilitaire, non whitelisted)print_formatCharge le format. Lève « Not a Print Designer Format » (libellé non traduit) si ce n'est pas un format Print Designer.
get_print_designer_formats (page de migration)aucunListe les formats Print Designer du site avec leur état : converti ou non, copie de l'éditeur, usages, document d'exemple. Masque les copies « (Editor) ».
preview_print_designer (page de migration)print_format, nameRenvoie le PDF du document rendu par Print Designer. Si le rendu enregistre une nouvelle entrée du Journal des erreurs pour ce format, répond par une page « No Preview » : « Print Designer can't render this format. » (libellés non traduits).
preview_conversion (page de migration)print_format, nameRenvoie le PDF du document rendu avec le résultat de la conversion, sans rien enregistrer.
convert_all (page de migration, POST)aucunConvertit chaque format non converti de la liste. Chaque conversion a son point de sauvegarde. Un échec est annulé, journalisé dans le Journal des erreurs et renvoyé dans failed. Renvoie {"converted": [...], "failed": [...]}.
convert (convertisseur, POST)print_formatConvertit un format comme décrit ci-dessus. Renvoie {"name": <format ou copie>, "notes": [...]}.
delete_print_designer_design (convertisseur, POST)print_formatEfface les champs Print Designer d'un format converti. Refuse un format standard, un format encore Print Designer ou un format qui n'est pas converti. Le format de l'éditeur est conservé.
use_editor_copy (convertisseur, POST)print_formatReporte les défauts du type de document et les liens vers le format standard sur sa copie, puis désactive le format standard. Lève une erreur s'il n'a pas de copie.

Page de migration

La page standard print-designer-migration (« Migrate Print Designer Formats », libellé non traduit) est réservée au rôle Responsable système. Elle est ouverte :

  • par le bouton Convertir au format de l'éditeur du formulaire d'un format enregistré issu de Print Designer. Il affiche l'URL /desk/print-designer-migration/<nom du format>, qui met la ligne du format en évidence ;
  • directement par l'URL /desk/print-designer-migration. La page n'a ni entrée de menu ni lien dans un espace de travail.

La page appelle les méthodes ci-dessus. Supprimer appelle la suppression standard du format (formats non convertis non livrés par une application), Delete Design appelle delete_print_designer_design et Use Copy appelle use_editor_copy (libellés non traduits sauf Supprimer).