Create a PDF document template - Revision history

Sonikf: /* Library for PDF manipulation */

2025-01-23T23:55:14Z

Library for PDF manipulation

← Older revision		Revision as of 23:55, 23 January 2025
Line 114:		Line 114:

	==Library for PDF manipulation==		==Library for PDF manipulation==
	The library used to create PDF documents in PHP is called TCPDF and can be found in ~~htdocs/includes/tcpdf/tcpdf.class.php (or~~ htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php). This class contains the methods used to generate different parts of documents.		The library used to create PDF documents in PHP is called TCPDF and can be found in htdocs/includes/tecnickcom/tcpdf/tcpdf.class.php. This class contains the methods used to generate different parts of documents.

	Templates instantiate the ~~FPDF~~ class and use its methods combined with the specific data of the invoice, order etc.		Templates instantiate the TCPDF class and use its methods combined with the specific data of the invoice, order etc.

	We can generally find the following calls into templates that generate PDF documents:		We can generally find the following calls into templates that generate PDF documents:

Sonikf: /* Customize content of your new template */

2025-01-23T23:52:46Z

Customize content of your new template

← Older revision		Revision as of 23:52, 23 January 2025
Line 106:		Line 106:
	Customize the new template:		Customize the new template:

	In file ~~pdf_propale_mycompanyblue~~.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.		In file pdf_mycompanyblue.modules.php, look for the function '_pagehead()' function. It is the function that manages the display of the header.

	Look for the '_pagefooter()' function. It is the function that manages the display of the footer.		Look for the '_pagefooter()' function. It is the function that manages the display of the footer.

Sonikf: /* Create a new template */

2025-01-23T23:45:00Z

Create a new template

← Older revision		Revision as of 23:45, 23 January 2025
Line 96:		Line 96:

	==For a new module==		==For a new module==
	Just use the [[Module Builder]] ~~from v12.0~~ to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).		Just use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder \|Module Builder]] AGAIN to create your module. When entering the name of a new object to create, you can also check a checkbox to say that you want to manage documents for such new object. In such a case, two templates will be automatically generated (one ODT template and one PDF template).

	The templates will be generated with path:		The templates will be generated with path:

Sonikf: /* For an existing core module */

2025-01-23T23:43:42Z

For an existing core module

← Older revision		Revision as of 23:43, 23 January 2025
Line 81:		Line 81:
	#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'		#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'
	#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.		#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('~~DocModelCyanDescription~~');'.		#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelMycompanyblueDescription');'.
	#Save file.		#Save file.

	* Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:		*Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:

	# 'models' => 0 to 'models' => 1		#'models' => 0 to 'models' => 1
	# Save file.		#Save file.
	* Activate your new module
			*Activate your new module

	Now the template will be available in the list of models in the admin settings of proposal.		Now the template will be available in the list of models in the admin settings of proposal.

Sonikf: /* For an existing core module */

2025-01-23T23:40:28Z

For an existing core module

← Older revision		Revision as of 23:40, 23 January 2025
Line 79:		Line 79:
	*Edit the file and make the following changes in the code:		*Edit the file and make the following changes in the code:

	#~~from <nowiki><syntaxhighlight lang="PHP">Class~~ pdf_cyan~~</syntaxhighlight></nowiki>~~ to ~~<nowiki><syntaxhighlight lang="PHP">Class~~ pdf_mycompanyblue~~</syntaxhighlight></nowiki>~~		#'class pdf_cyan extends ModelePDFPropales' to 'class pdf_mycompanyblue extends ModelePDFPropales'
	#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.		#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.		#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.
Line 88:		Line 88:
	# 'models' => 0 to 'models' => 1		# 'models' => 0 to 'models' => 1
	# Save file.		# Save file.
			* Activate your new module

			Now the template will be available in the list of models in the admin settings of proposal.
	Now the template will be available in the list of models in ~~Dolibarr~~.

	Test this model (see previous section) before going further.		Test this model (see previous section) before going further.

	~~<br />~~

	==For a new module==		==For a new module==

Sonikf: /* For an existing core module */

2025-01-23T23:30:20Z

For an existing core module

← Older revision		Revision as of 23:30, 23 January 2025
Line 79:		Line 79:
	*Edit the file and make the following changes in the code:		*Edit the file and make the following changes in the code:

	#'Class pdf_cyan' to 'Class pdf_mycompanyblue'		#from <nowiki><syntaxhighlight lang="PHP">Class pdf_cyan</syntaxhighlight></nowiki> to <nowiki><syntaxhighlight lang="PHP">Class pdf_mycompanyblue</syntaxhighlight></nowiki>
	#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.		#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.		#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.
	#Save file.		#Save file.

			* Edit the file custom/mymodule/core/modules/modMymodule.class.php and make the following changes in the code:

			# 'models' => 0 to 'models' => 1
			# Save file.


	Now the template will be available in the list of models in Dolibarr.		Now the template will be available in the list of models in Dolibarr.

Sonikf: /* For an existing core module */

2025-01-23T23:18:10Z

For an existing core module

← Older revision		Revision as of 23:18, 23 January 2025
Line 67:		Line 67:
	==For an existing core module==		==For an existing core module==
	Do not directly modify an existing template.		Do not directly modify an existing template.

	Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).		Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).

Line 81:		Line 82:
	#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.		#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.		#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.
	#Save file.		#Save file.

	Now the template will be available in the list of models in Dolibarr.		Now the template will be available in the list of models in Dolibarr.

Sonikf: /* For an existing core module */

2025-01-23T23:15:49Z

For an existing core module

← Older revision		Revision as of 23:15, 23 January 2025
Line 69:		Line 69:
	Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).		Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).

	Instead use the ~~the Module Builder~~ [[Module ~~development~~]] available from v12.0 to create your own module even for just a new template.		Instead use the [[https://wiki.dolibarr.org/index.php?title=Module_development#Module_creation_with_the_module_builder \|Module Builder]] available from v12.0 to create your own module even for just a new template.

	For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':		For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':

Sonikf: /* Create a new template */

2025-01-23T23:06:35Z

Create a new template

← Older revision		Revision as of 23:06, 23 January 2025
Line 65:		Line 65:

	=Create a new template=		=Create a new template=
	==For an existing module==		==For an existing core module==
	Do not directly modify an existing template. ~~Copy~~ the file of the template used as example into a new name in same directory and edit it to change content.		Do not directly modify an existing template.
	~~For this example, we will call our new template 'mycompanyblue', based on the existing template 'cyan':~~		Although it is possible to copy the file of the template used as example into a new name in same directory and edit it to change content it is strongly recommended not to modify any core file or structure(If you want to fix something use the project Github page to propose your changes).

	*Copy and paste file pdf_cyan.modules.php		Instead use the the Module Builder [[Module development]] available from v12.0 to create your own module even for just a new template.

			For this example, we will call our new module 'mymodule' and our template 'mycompanyblue', based on the existing template 'cyan':


			*Copy and paste file pdf_cyan.modules.php into custom/mymodule/core/modules/propale/doc
	*Rename the copy as pdf_mycompanyblue.modules.php		*Rename the copy as pdf_mycompanyblue.modules.php
	*Edit and make the following changes in the code:		*Edit the file and make the following changes in the code:

	#~~Rename~~ 'Class pdf_cyan { ' to 'Class pdf_mycompanyblue { '		#'Class pdf_cyan' to 'Class pdf_mycompanyblue'
	#~~Rename constant~~ $this->name ~~to match your new template name. For example for '~~cyan' ~~template, change line~~ '$this->name = "~~cyan~~";' to '$this->~~name~~ = ~~"mycompanyblue"~~;'.		#'$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#Save file. Now the template will be available in the list of models in Dolibarr.		#'$this->description = $langs->trans('DocModelCyanDescription');' to '$this->description = $langs->trans('DocModelCyanDescription');'.
			#Save file.
			Now the template will be available in the list of models in Dolibarr.

	Test this model (see previous section) before going further.		Test this model (see previous section) before going further.

Sonikf: /* For an existing module */

2025-01-23T22:02:35Z

For an existing module

← Older revision		Revision as of 22:02, 23 January 2025
Line 67:		Line 67:
	==For an existing module==		==For an existing module==
	Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.		Do not directly modify an existing template. Copy the file of the template used as example into a new name in same directory and edit it to change content.
	For this example, we will call our new template 'mycompanyblue', based on the existing template '~~azur~~':		For this example, we will call our new template 'mycompanyblue', based on the existing template 'cyan':

	*Copy and paste file ~~pdf_propale_azur~~.modules.php		*Copy and paste file pdf_cyan.modules.php
	*Rename the copy as ~~pdf_propale_mycompanyblue~~.modules.php		*Rename the copy as pdf_mycompanyblue.modules.php
	*Edit and make the following changes in the code:		*Edit and make the following changes in the code:

	#Rename 'Class ~~pdf_propale_azur~~ { ' to 'Class ~~pdf_propale_mycompanyblue~~ { '		#Rename 'Class pdf_cyan { ' to 'Class pdf_mycompanyblue { '
	#Rename constant $this->name to match your new template name. For example for '~~azur~~' template, change line '$this->name = "~~azur~~";' to '$this->name = "mycompanyblue";'.		#Rename constant $this->name to match your new template name. For example for 'cyan' template, change line '$this->name = "cyan";' to '$this->name = "mycompanyblue";'.
	#Save file. Now the template will be available in the list of models in Dolibarr.		#Save file. Now the template will be available in the list of models in Dolibarr.