创建PDF模板 - Revision history

ShengGang: /* Proposer son modèle via un module */

2023-10-10T08:46:41Z

Proposer son modèle via un module

← Older revision		Revision as of 08:46, 10 October 2023
Line 147:		Line 147:
	*http://www.fpdf.org/?lang=en		*http://www.fpdf.org/?lang=en
	*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>		*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>
	*

	=~~激活您的新模板~~=		=通过模块提供您的模板=
	~~前往 '''主页 => 设置 => 模块/应用 =>'''~~		如果制作的模板打算通过Dolibarr扩展模块交付（请参阅文档以创建Dolibarr模块），则您的模板文件将不与其他模板文件位于同一目录中，因此不会被自动检测到。要使其可被检测到，您需要在扩展模块的初始化函数中添加以下行：

	*激活您的模块
	*最终，将其设置为默认模板

	~~=Proposer son modèle via un module=~~
	Si le modèle fabriqué est destiné à être livré via un module extension de Dolibarr (voir la doc pour faire un module Dolibarr), le fichier modèle ne sera pas dans le même répertoire que les autres, et ne sera donc pas détecté automatiquement. Pour le rendre détectable vous devrez ajouter cette ligne dans la fonction d'initialisation de votre module externe :

	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
Line 162:		Line 155:
	</syntaxhighlight>		</syntaxhighlight>

	~~avant~~		前面

	<syntaxhighlight lang="PHP"> return $this->_init($sql,$option);</syntaxhighlight>		<syntaxhighlight lang="PHP"> return $this->_init($sql,$option);</syntaxhighlight>

	~~Puis~~		之后，前往 '''主页 => 设置 => 模块/应用 => 模板所在的模块=>配置'''

	~~Dans Accueil => Configuration => Modules => Module sur lequel porte le modèle => Configurer~~		*激活应该出现在可用模块中的您的模块
			*可以将其设置为默认建议的模板

	*activer votre module qui doit apparaître parmi ceux disponible		=关于该主题的视频=
	*éventuellement le mettre en modèle proposé par défaut.		<youtube width="200" height="120">dEC8hFcT71U</youtube>

	~~=Vidéos sur le sujet=~~
	~~<youtube width="200" height="120">dEC8hFcT71U</youtube>~~
	<youtube width="200" height="120">LtXPBz9fWQE</youtube>		<youtube width="200" height="120">LtXPBz9fWQE</youtube>

	=故障排除=		=故障排除=

	==~~Q: My PDF template doesn't understand foreign characters, it outputs them as~~ ???==		==问题：我的PDF模板无法识别外语字符，它会将它们输出为 ???==

	~~This is probably a font problem, the current font used for generating the PDF cannot handle the foreign characters you are trying to print. So just try to use another set of font.~~		这可能是字体的问题，当前用于生成PDF的字体无法处理您试图打印的外语字符。所以，请尝试使用另一种字体。

	~~You will find the fonts used by Dolibarr to print PDF inside your Dolibarr folder~~.../includes/tcpdf/fonts/		您将在您的Dolibarr文件夹中找到Dolibarr用于打印PDF的字体：.../includes/tcpdf/fonts/

	~~To change the font used for generating PDF, you need to edit the 'main~~.~~lang' file of the language you are using (you'll find the file in your~~ Dolibarr.../langs/en_US/main.lang ~~for instance if you use English)~~		要更改用于生成PDF的字体，您需要编辑您正在使用的语言的“main.lang”文件（例如，如果您使用英语，您可以在您的 Dolibarr.../langs/en_US/main.lang 中找到该文件）

	*~~Edit the~~ main.lang ~~file~~		*编辑文件 main.lang
	*~~Locate the constant FONTFORPDF at the beginning of the file and change the value to FONTFORPDF~~=~~dejavusans for instance if you want to use dejavusans. Please note that sometimes FONTFORPDF may be missing, in this case you should add it at the beginning of the file.~~		*找到文件开头的常量FONTFORPDF，并将值更改为FONTFORPDF=dejavusans，例如，如果您想使用dejavusan。请注意，有时FONTFORPDF可能会丢失，在这种情况下，您应该将其添加到文件的开头。
	*~~Save the file and try again to generate your PDF.~~		*保存文件，然后再次尝试生成PDF。

	~~If you are unlucky, you can try with more fonts, just go to the TCPDF website~~ sourceforge.net/projects/~~tcpdf~~/files/ ~~and download the latest zip package. Then extract only the 'fonts' folder from the zip. Then copy the files in your Dolibarr installation~~ .../includes/tcpdf/fonts/ ~~so you will get more fonts to play with.~~		如果你运气不好，你可以尝试使用更多的字体，只需访问TCPDF网站 sourceforge.net/projects/TCPDF/files/ 并下载最新的zip包。然后只从zip中提取“fonts”文件夹。最后复制到Dolibarr安装中的 .../includes/tcpdf/fonts/，这样您将获得更多可供使用的字体。

	~~Also, please make a backup of your files before to modify.~~		此外，请在修改之前备份您的文件。

	~~Alternative if this doesn't work: make sure the Translation class is correctly instanciated and loaded with the correct language inside your PDF templates (stored inside the~~ $~~langs or~~ $~~outputlangs variable).~~		如果这不起作用，请选择：确保Translation类已正确安装，并在PDF模板中加载了正确的语言（存储在$langs或$outputlangs变量中）。

	~~Thank's to~~ Humphrey ~~for the tip.~~		感谢 Humphrey 的提示。

ShengGang at 08:24, 10 October 2023

2023-10-10T08:24:02Z

@@ Line 154: / Line 154: @@
 *激活您的模块
 *最终，将其设置为默认模板
 =故障排除=

ShengGang: /* Add a PDF Annotation (comment) */

2023-10-10T08:23:33Z

Add a PDF Annotation (comment)

← Older revision		Revision as of 08:23, 10 October 2023
Line 127:		Line 127:
	提醒：setXY 函数的原点位于页面的左上角		提醒：setXY 函数的原点位于页面的左上角

	===~~Add a PDF Annotation (comment)~~===		===添加PDF批注（注释）===
	''~~Left side of the page around the middle:~~''		''页面左侧围绕中间：''

	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));		$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));
	</syntaxhighlight>		</syntaxhighlight>

	''~~Right side of the page around the middle:~~''		''页面右侧围绕中间：''

	<syntaxhighlight lang="PHP">		<syntaxhighlight lang="PHP">
	$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));		$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));
	</syntaxhighlight>		</syntaxhighlight>

	===~~Add Complementary Attribute (extrafiled)~~===		===添加补充属性（额外字段）===
	~~A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr~~ [[Add Extrafields on PDF Models]]		一个专门的页面为您提供了一些建议，如何将补充属性（额外字段）集成到Dolibarr的PDF模板中：[[Add Extrafields on PDF Models\|在PDF模板上添加额外字段]]

	==如需了解更多信息==		==如需了解更多信息==

			*http://www.fpdf.org/?lang=en
	*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>		*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>
	*		*

	=~~激活模块~~=		=激活您的新模板=
	~~In page Home~~ => ~~Setup~~ => ~~Modules~~ =>		前往 '''主页 => 设置 => 模块/应用 =>'''

	*~~activate your module~~		*激活您的模块
	*~~eventually, set it as the default model.~~		*最终，将其设置为默认模板

	=故障排除=		=故障排除=

ShengGang: /* 个性化示例 */

2023-10-10T08:13:05Z

个性化示例

← Older revision		Revision as of 08:13, 10 October 2023
Line 126:		Line 126:

	提醒：setXY 函数的原点位于页面的左上角		提醒：setXY 函数的原点位于页面的左上角

			===Add a PDF Annotation (comment)===
			''Left side of the page around the middle:''
			<syntaxhighlight lang="PHP">
			$pdf->Annotation(102, 202, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));
			</syntaxhighlight>

			''Right side of the page around the middle:''
			<syntaxhighlight lang="PHP">
			$pdf->Annotation(202, 102, 10, 10, "this is the comment text", array('Subtype'=>'Text', 'Name' => 'Comment', 'T' => 'this is comment author', 'Subj' => 'this is comment title', 'C' => array(255, 255, 0)));
			</syntaxhighlight>

			===Add Complementary Attribute (extrafiled)===
			A dedicated page give you some advises how to integrate complementary attributes (extrafields) into PDF models of Dolibarr [[Add Extrafields on PDF Models]]

	==如需了解更多信息==		==如需了解更多信息==

ShengGang: /* 更多信息 */

2023-10-10T08:12:13Z

更多信息

← Older revision		Revision as of 08:12, 10 October 2023
Line 100:		Line 100:
	*如果logo位于现有文本的下方或上方，请通过注释掉显示信息的代码或更改其位置来删除现有文本。		*如果logo位于现有文本的下方或上方，请通过注释掉显示信息的代码或更改其位置来删除现有文本。

	=== 在发票页面底部插入签名或其他内容 ===		===在发票页面底部插入签名或其他内容===

	*打开要编辑和插入的.php文件		*打开要编辑和插入的.php文件
Line 127:		Line 127:
	提醒：setXY 函数的原点位于页面的左上角		提醒：setXY 函数的原点位于页面的左上角

	==~~更多信息~~==		==如需了解更多信息==

	*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>		*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>
	*		*

ShengGang: /* 插入 logo */

2023-10-10T08:09:47Z

插入 logo

← Older revision		Revision as of 08:09, 10 October 2023
Line 90:		Line 90:
	===插入 logo===		===插入 logo===

	*~~Add following instructions~~		*添加说明

	<source lang="php">		<source lang="php">
	$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);		$pdf->Image('\www\htdocs\dolibarr\document\societe\logo.jpg', 10, 5, 60.00);
	</source>		</source>
	~~With this example: 10=abscissa, 5=ordinate, 60=with of logo~~

	*~~If logo is on or outside existing text~~, ~~remove exisiting text by commenting the code that output the text or by changing its position.~~		在示例中：10=横坐标，5=纵坐标，60=logo宽度

			*如果logo位于现有文本的下方或上方，请通过注释掉显示信息的代码或更改其位置来删除现有文本。

			=== 在发票页面底部插入签名或其他内容 ===

			*打开要编辑和插入的.php文件

			<syntaxhighlight lang="PHP">
			$pdf->Image(DOL_DOCUMENT_ROOT.'/mydir/signature.jpg',120,250,74);
			</syntaxhighlight>

			图像（74mm宽）显示在页脚前的右栏中。

			*将图像复制到目录。具有透明度的PNG图像似乎是有问题的。
			*生成PDF时，将显示签名。

	===插入文本===		===插入文本===
	~~Most comme function to use~~		使用的主要功能

	<source lang="php">		<source lang="php">
	$pdf->setX(float a); // set current x position		$pdf->setX(float a); // set current x position
Line 109:		Line 124:
	$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne		$pdf->MultiCell(60, 8, 'Mon texte", 0, 'L'); // imprime 'Mon texte' avec saut de ligne
	</source>		</source>
	~~Note: Origin for setXY functions are the top left corner of page.~~
			提醒：setXY 函数的原点位于页面的左上角

	==更多信息==		==更多信息==

	*~~List of TCPDF's methods~~: tcpdf.org/~~doc~~/~~code~~/~~classTCPDF.html~~		*TCPDF函数清单：<nowiki>https://tcpdf.org/docs/srcdoc/</nowiki>
			*

	=激活模块=		=激活模块=

ShengGang: /* 定制实例 */

2023-10-10T03:56:38Z

定制实例

← Older revision		Revision as of 03:56, 10 October 2023
Line 87:		Line 87:
	*_pagefoot() - ''绘制页脚的方法''		*_pagefoot() - ''绘制页脚的方法''

	==~~定制实例~~==		==个性化示例==
	===插入 logo===		===插入 logo===

ShengGang: /* 脚本框架 */

2023-10-10T03:55:31Z

脚本框架

← Older revision		Revision as of 03:55, 10 October 2023
Line 75:		Line 75:
	*$pdf->Rect() - ''绘制一个矩形，其左上角位于前两个参数指示的点，右下角在前两个参数的相对模式下使用最后两个参数''		*$pdf->Rect() - ''绘制一个矩形，其左上角位于前两个参数指示的点，右下角在前两个参数的相对模式下使用最后两个参数''

	==~~脚本框架~~==		==脚本结构==
	~~During the development of version 2.2, the scripts used for generating PDF documents had the following methods (taking as example the model "crabe") inside the class with the model's name:~~		用于生成PDF文档的脚本在模板类中具有以下方法（以“crabe”模板为例）：

	*pdf_crabe() - ''~~Creator of the object pdf~~''		*pdf_crabe() - ''PDF对象的构造函数''
	*write_pdf_file() - ''~~General method for generating the file. This method calls all the following ones after initializing some variables~~''		*write_pdf_file() - ''生成文件的通用函数。此方法在初始化一些变量后调用以下所有变量''
	*_pagehead() - ''~~Method for drawing the heading of the document, including in general the logo, the title of the document (and the date) as well as the frames of the issuer and the addressee of the document~~''		*_pagehead() - ''绘制文档标题的函数，通常包括徽标、文档标题（和日期）以及文档发送者和接收者的框架''
	*_tableau() - ''~~Method for drawing the details table (products, services,...)~~''		*_tableau() - ''详细信息表（产品、服务等）的绘制方法''
	*_tableau_info() - ''~~Method for drawing the table containing information list present in the bill~~''		*_tableau_info() - ''绘制包含发票上信息列表的表格的方法''
	*_tableau_tot() - ''~~Method for drawing table of Totals~~''		*_tableau_tot() - ''绘制总计表的方法''
	*_tableau_versement() - ''~~Method for drawing table of payment rules~~''		*_tableau_versement() - ''绘制支付规则表的方法''
	*_pagefoot() - ''~~Method for drawing bottom of the page~~''		*_pagefoot() - ''绘制页脚的方法''

	==定制实例==		==定制实例==

ShengGang: /* PDF操作库 */

2023-10-10T03:48:02Z

PDF操作库

← Older revision		Revision as of 03:48, 10 October 2023
Line 49:		Line 49:
	生成的模板将保存在如下路径中：		生成的模板将保存在如下路径中：

	* custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php		*custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php
	* custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php		*custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php

	=自定义您的新模板=		=自定义您的新模板=
Line 61:		Line 61:
	查找函数 write_file() 。它显示PDF的正文。		查找函数 write_file() 。它显示PDF的正文。

	==~~PDF操作库~~==		==用于PDF操作的库==
	~~用于在PHP语言中创建PDF文档的库被称为FPDF，可以被找到于~~'''htdocs/includes/tcpdf/tcpdf.class.php'''~~文件中。在这个类中，您可以找到用于生成文档不同部分的所有不同方法。~~		用于创建PDF文档的库被称为TCPDF，可以在'''htdocs/includes/tcpdf/tcpdf.class.php'''中找到。在这个类中，您还可以找到许多用于生成文档的不同元素的方法。

	~~模板实例化了此FPDF类，并使用其方法，结合了发票、订单或其他类型的数据。~~		PDF生成模板通过调用 pdf_getInstance() 来实例化PDF对象，然后将其方法与发票、订单或其他对象中的数据结合使用。

	~~我们可以在生成PDF文档的模板时调用以下函数：~~		在文档创建脚本中通常会发现以下调用：

	*$pdf->SetFont() - ''~~Define the font to use for the text~~''		*$pdf->SetFont() - ''指定用于后续文本的字体''
	*$pdf->SetXY() - ''~~Define position (X,Y) for next text that will be output onto page~~''		*$pdf->SetXY() - ''指定以X、Y坐标绘制下一个文本的起点，以页面的毫米为单位''
	*$pdf->MultiCell() - ''~~Draw a box containing text. Used to output any text~~''		*$pdf->MultiCell() - ''绘制一个可以包含文本的框，其中必须首先给出宽度和高度-非常常用''
	*$pdf->GetY() - ''~~Return current Y position~~''		*$pdf->GetY() - ''返回Y的当前位置''
	*$pdf->SetDrawColor() - ''~~Set the color to use for new text to write~~ - ~~ie black~~ (0,0,0) ~~or white~~ (255,255,255)''		*$pdf->SetDrawColor() - ''指定用于下一个要写入的文本的颜色-通常为黑色(0,0,0)或白色 (255,255,255)''
	*$pdf->Rect() - ''~~Drwa a rectanle whose top left corner coordinates ared defineds by two first parameters and bottom right corner is defined by two following parameters that are relative values~~''		*$pdf->Rect() - ''绘制一个矩形，其左上角位于前两个参数指示的点，右下角在前两个参数的相对模式下使用最后两个参数''

	==脚本框架==		==脚本框架==

ShengGang: /* 使用模块生成器创建 */

2023-10-10T03:34:10Z

使用模块生成器创建

← Older revision		Revision as of 03:34, 10 October 2023
Line 41:		Line 41:

	*通过在与模板相关的模块配置页面（即我们示例中的报价单模块配置页面）中激活此模板，并显示预览来测试此模板...		*通过在与模板相关的模块配置页面（即我们示例中的报价单模块配置页面）中激活此模板，并显示预览来测试此模板...

			将您创建的新文档模板添加到表 '''llx_document_model''' 中。

	==使用模块生成器创建==		==使用模块生成器创建==
	适用		使用 v12.0 中的模块生成器创建新模块。输入要创建的新对象的名称时，可以选中复选框以表示要管理此类新对象的文档。在这种情况下，将自动生成两个模板（一个 ODT 模板和一个 PDF 模板）。

			生成的模板将保存在如下路径中：

			* custom/mymodule/core/modules/doc/pdf_standard_myobject.class.php
			* custom/mymodule/core/modules/doc/doc_generic_myobject_odt.class.php

			=自定义您的新模板=
			通过修改代码来自定义您创建的模板：

			在 pdf_propale_mycompanyblue.modules.php 中查找函数 _pagehead() 。它负责管理标题的显示。

			查找函数 _pagefooter() 。它负责管理页脚的显示。

	~~=自定义新模板的内容=~~		查找函数 write_file() 。它显示PDF的正文。
	~~自定义创建的模板。仍然在文件pdf_propale_mycompanyblue.modules.php，搜索函数 'Function _pagehead~~ (~~&$pdf, $fac~~)~~'。它管理标题的显示。~~

	==PDF操作库==		==PDF操作库==