Skip to content

Commit 6387699

Browse files
Jean-BeruJean-Beru
committed
fix(doc): annotations
1 parent 7ae906e commit 6387699

22 files changed

+624
-171
lines changed

‎docs/pdf/builders_api/ConvertPdfBuilder.md

Lines changed: 26 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,43 @@
44
> See: [https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route](https://gotenberg.dev/docs/routes#convert-into-pdfa--pdfua-route)
55
66
### downloadFrom(array $downloadFrom)
7-
Sets download from to download each entry (file) in parallel (default None).<br />(URLs MUST return a Content-Disposition header with a filename parameter.).<br />
7+
Sets download from to download each entry (file) in parallel (URLs MUST return a Content-Disposition header with a filename parameter.).<br />
8+
9+
> [!TIP]
10+
> See: [https://gotenberg.dev/docs/routes#download-from](https://gotenberg.dev/docs/routes#download-from)
811
912
### files(Stringable|string $paths)
10-
### getBodyBag()
11-
### getHeadersBag()
1213
### pdfFormat(?Sensiolabs\GotenbergBundle\Enumeration\PdfFormat $format)
1314
Convert the resulting PDF into the given PDF/A format.
1415

1516
### pdfUniversalAccess(bool $bool)
16-
Enable PDF for Universal Access for optimal accessibility. (default false).
17+
Enable PDF for Universal Access for optimal accessibility.
1718

1819
### type()
1920
### webhook(array $webhook)
2021
### webhookErrorRoute(string $route, array $parameters, ?string $method)
22+
> [!TIP]
23+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
24+
2125
### webhookErrorUrl(string $url, ?string $method)
26+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
27+
28+
> [!TIP]
29+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
30+
2231
### webhookExtraHeaders(array $extraHttpHeaders)
32+
Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.<br />
33+
34+
> [!TIP]
35+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
36+
2337
### webhookRoute(string $route, array $parameters, ?string $method)
38+
> [!TIP]
39+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
40+
2441
### webhookUrl(string $url, ?string $method)
42+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
43+
44+
> [!TIP]
45+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
46+

‎docs/pdf/builders_api/HtmlPdfBuilder.md

Lines changed: 97 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Add cookies to store in the Chromium cookie jar.<br />
1313
> See: [https://gotenberg.dev/docs/routes#cookies-chromium ](https://gotenberg.dev/docs/routes#cookies-chromium )
1414
1515
### addExtraHttpHeaders(array $headers)
16-
Adds extra HTTP headers that Chromium will send when loading the HTML<br />document. (default None).<br />
16+
Adds extra HTTP headers that Chromium will send when loading the HTML document.<br />
1717

1818
> [!TIP]
1919
> See: [https://gotenberg.dev/docs/routes#custom-http-headers-chromium ](https://gotenberg.dev/docs/routes#custom-http-headers-chromium )
@@ -30,13 +30,16 @@ The HTML file to convert into PDF.
3030

3131
### cookies(array $cookies)
3232
### downloadFrom(array $downloadFrom)
33-
Sets download from to download each entry (file) in parallel (default None).<br />(URLs MUST return a Content-Disposition header with a filename parameter.).<br />
33+
Sets download from to download each entry (file) in parallel (URLs MUST return a Content-Disposition header with a filename parameter.).<br />
34+
35+
> [!TIP]
36+
> See: [https://gotenberg.dev/docs/routes#download-from](https://gotenberg.dev/docs/routes#download-from)
3437
3538
### emulatedMediaType(Sensiolabs\GotenbergBundle\Enumeration\EmulatedMediaType $mediaType)
3639
Forces Chromium to emulate, either "screen" or "print". (default "print").
3740

3841
### extraHttpHeaders(array $headers)
39-
Sets extra HTTP headers that Chromium will send when loading the HTML<br />document. (default None). (overrides any previous headers).<br />
42+
Sets extra HTTP headers that Chromium will send when loading the HTML document. (overrides any previous headers).<br />
4043

4144
> [!TIP]
4245
> See: [https://gotenberg.dev/docs/routes#custom-http-headers-chromium ](https://gotenberg.dev/docs/routes#custom-http-headers-chromium )
@@ -54,7 +57,7 @@ Return a 409 Conflict response if the HTTP status code from<br />the main page i
5457
> See: [https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium ](https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium )
5558
5659
### failOnResourceHttpStatusCodes(array $statusCodes)
57-
Return a 409 Conflict response if the HTTP status code from at least one resource is not acceptable.<br />(default None). (overrides any previous configuration).<br />
60+
Return a 409 Conflict response if the HTTP status code from at least one resource is not acceptable. (overrides any previous configuration).<br />
5861

5962
> [!TIP]
6063
> See: [https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium ](https://gotenberg.dev/docs/routes#invalid-http-status-codes-chromium )
@@ -67,35 +70,54 @@ Forces GotenbergPdf to return a 409 Conflict response if Chromium fails to load
6770
6871
### footer(string $template, array $context)
6972
### footerFile(string $path)
70-
HTML file containing the footer. (default None).
73+
HTML file containing the footer.
7174

7275
### forwardCookie(string $name)
7376
### generateDocumentOutline(bool $bool)
74-
Define whether the document outline should be embedded into the PDF.
77+
Define whether the document outline should be embedded into the PDF.<br />
78+
79+
> [!TIP]
80+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
7581
76-
### getBodyBag()
77-
### getHeadersBag()
7882
### header(string $template, array $context)
7983
### headerFile(string $path)
80-
HTML file containing the header. (default None).
84+
HTML file containing the header.
8185

8286
### landscape(bool $bool)
83-
Set the paper orientation to landscape. (Default false).
87+
Set the paper orientation to landscape.<br />
88+
89+
> [!TIP]
90+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
8491
8592
### marginBottom(float $value, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
86-
Specify bottom margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
93+
Specify bottom margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.<br />
94+
95+
> [!TIP]
96+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
8797
8898
### marginLeft(float $value, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
89-
Specify left margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
99+
Specify left margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.<br />
100+
101+
> [!TIP]
102+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
90103
91104
### marginRight(float $value, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
92-
Specify right margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
105+
Specify right margin using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.<br />
106+
107+
> [!TIP]
108+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
93109
94110
### marginTop(float $value, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
95-
Specify top margin width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
111+
Specify top margin width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.<br />
112+
113+
> [!TIP]
114+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
96115
97116
### margins(float $top, float $bottom, float $left, float $right, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
98-
Overrides the default margins (e.g., 0.39), in inches.
117+
Overrides the default margins (e.g., 0.39), in inches.<br />
118+
119+
> [!TIP]
120+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
99121
100122
### metadata(array $metadata)
101123
Resets the metadata.<br />
@@ -108,10 +130,16 @@ Resets the metadata.<br />
108130
> See: [https://exiftool.org/TagNames/XMP.html#pdf ](https://exiftool.org/TagNames/XMP.html#pdf )
109131
110132
### nativePageRanges(string $ranges)
111-
Page ranges to print, e.g., '1-5, 8, 11-13'. (default All pages).
133+
Page ranges to print, e.g., '1-5, 8, 11-13'.<br />
134+
135+
> [!TIP]
136+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
112137
113138
### omitBackground(bool $bool)
114-
Hide the default white background and allow generating PDFs with transparency.
139+
Hide the default white background and allow generating PDFs with transparency.<br />
140+
141+
> [!TIP]
142+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
115143
116144
### paperHeight(float $value, Sensiolabs\GotenbergBundle\Enumeration\Unit $unit)
117145
Specify paper height using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. Default unit is inches if unspecified.
@@ -127,53 +155,95 @@ Specify paper width using units like 72pt, 96px, 1in, 25.4mm, 2.54cm, or 6pc. De
127155
Convert the resulting PDF into the given PDF/A format.
128156

129157
### pdfUniversalAccess(bool $bool)
130-
Enable PDF for Universal Access for optimal accessibility. (default false).
158+
Enable PDF for Universal Access for optimal accessibility.
131159

132160
### preferCssPageSize(bool $bool)
133-
Define whether to prefer page size as defined by CSS. (Default false).
161+
Define whether to prefer page size as defined by CSS.<br />
162+
163+
> [!TIP]
164+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
134165
135166
### printBackground(bool $bool)
136-
Prints the background graphics. (Default false).
167+
Prints the background graphics.<br />
168+
169+
> [!TIP]
170+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
137171
138172
### scale(float $scale)
139-
The scale of the page rendering (e.g., 1.0). (Default 1.0).
173+
The scale of the page rendering (e.g., 1.0).<br />
174+
175+
> [!TIP]
176+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
140177
141178
### setCookie(string $name, Symfony\Component\HttpFoundation\Cookie|array $cookie)
142179
### singlePage(bool $bool)
143180
Define whether to print the entire content in one single page.<br /><br />If the singlePage form field is set to true, it automatically overrides the values from the paperHeight and nativePageRanges form fields.
144181

145182
### skipNetworkIdleEvent(bool $bool)
146183
### splitMode(?Sensiolabs\GotenbergBundle\Enumeration\SplitMode $splitMode)
147-
Either intervals or pages. (default None).
184+
Either intervals or pages.<br />
185+
186+
> [!TIP]
187+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
188+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
148189
149190
### splitSpan(string $splitSpan)
150-
Either the intervals or the page ranges to extract, depending on the selected mode. (default None).
191+
Either the intervals or the page ranges to extract, depending on the selected mode.<br />
192+
193+
> [!TIP]
194+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
195+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
151196
152197
### splitUnify(bool $bool)
153-
Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).
198+
Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).<br />
199+
200+
> [!TIP]
201+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
202+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
154203
155204
### type()
156205
### userAgent(string $userAgent)
157-
Override the default User-Agent HTTP header. (default None).<br />
206+
Override the default User-Agent HTTP header.<br />
158207

159208
> [!TIP]
160209
> See: [https://gotenberg.dev/docs/routes#custom-http-headers-chromium](https://gotenberg.dev/docs/routes#custom-http-headers-chromium)
161210
162211
### waitDelay(string $delay)
163-
Sets the duration (i.e., "1s", "2ms", etc.) to wait when loading an HTML<br />document before converting it to PDF. (default None).<br />
212+
Sets the duration (i.e., "1s", "2ms", etc.) to wait when loading an HTML<br />document before converting it to PDF.<br />
164213

165214
> [!TIP]
166215
> See: [https://gotenberg.dev/docs/routes#wait-before-rendering-chromium](https://gotenberg.dev/docs/routes#wait-before-rendering-chromium)
167216
168217
### waitForExpression(string $expression)
169-
Sets the JavaScript expression to wait before converting an HTML<br />document to PDF until it returns true. (default None).<br /><br />For instance: "window.status === 'ready'".<br />
218+
Sets the JavaScript expression to wait before converting an HTML document to PDF until it returns true.<br /><br />For instance: "window.status === 'ready'".<br />
170219

171220
> [!TIP]
172221
> See: [https://gotenberg.dev/docs/routes#wait-before-rendering](https://gotenberg.dev/docs/routes#wait-before-rendering)
173222
174223
### webhook(array $webhook)
175224
### webhookErrorRoute(string $route, array $parameters, ?string $method)
225+
> [!TIP]
226+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
227+
176228
### webhookErrorUrl(string $url, ?string $method)
229+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
230+
231+
> [!TIP]
232+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
233+
177234
### webhookExtraHeaders(array $extraHttpHeaders)
235+
Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.<br />
236+
237+
> [!TIP]
238+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
239+
178240
### webhookRoute(string $route, array $parameters, ?string $method)
241+
> [!TIP]
242+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
243+
179244
### webhookUrl(string $url, ?string $method)
245+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
246+
247+
> [!TIP]
248+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
249+

‎docs/pdf/builders_api/LibreOfficePdfBuilder.md

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,10 @@ Specify whether form fields are exported as widgets or only their fixed print re
2525
Specify whether to update the indexes before conversion, keeping in mind that doing so might result in missing links in the final PDF.
2626

2727
### downloadFrom(array $downloadFrom)
28-
Sets download from to download each entry (file) in parallel (default None).<br />(URLs MUST return a Content-Disposition header with a filename parameter.).<br />
28+
Sets download from to download each entry (file) in parallel (URLs MUST return a Content-Disposition header with a filename parameter.).<br />
29+
30+
> [!TIP]
31+
> See: [https://gotenberg.dev/docs/routes#download-from](https://gotenberg.dev/docs/routes#download-from)
2932
3033
### exportBookmarksToPdfDestination(bool $bool)
3134
Specify that the bookmarks contained in the source LibreOffice file should be exported to the PDF file as Named Destination.
@@ -57,10 +60,11 @@ Adds office files to convert (overrides any previous files).
5760
### flatten(bool $bool)
5861
Flattening a PDF combines all its contents into a single layer. (default false).
5962

60-
### getBodyBag()
61-
### getHeadersBag()
6263
### landscape(bool $bool)
63-
Set the paper orientation to landscape.
64+
Set the paper orientation to landscape.<br />
65+
66+
> [!TIP]
67+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
6468
6569
### losslessImageCompression(bool $bool)
6670
Specify if images are exported to PDF using a lossless compression format like PNG or compressed using the JPEG format.
@@ -82,7 +86,10 @@ Resets the metadata.<br />
8286
> See: [https://exiftool.org/TagNames/XMP.html#pdf ](https://exiftool.org/TagNames/XMP.html#pdf )
8387
8488
### nativePageRanges(string $ranges)
85-
Page ranges to print, e.g., '1-4' - empty means all pages.
89+
Page ranges to print, e.g., '1-4' - empty means all pages.<br />
90+
91+
> [!TIP]
92+
> See: [https://gotenberg.dev/docs/routes#page-properties-chromium](https://gotenberg.dev/docs/routes#page-properties-chromium)
8693
8794
### password(string $password)
8895
Set the password for opening the source file.
@@ -91,7 +98,7 @@ Set the password for opening the source file.
9198
Convert the resulting PDF into the given PDF/A format.
9299

93100
### pdfUniversalAccess(bool $bool)
94-
Enable PDF for Universal Access for optimal accessibility. (default false).
101+
Enable PDF for Universal Access for optimal accessibility.
95102

96103
### quality(int $quality)
97104
Specify the quality of the JPG export. A higher value produces a higher-quality image and a larger file. Between 1 and 100.<br />
@@ -106,18 +113,51 @@ Ignore each sheet’s paper size, print ranges and shown/hidden status and puts
106113
Specify that automatically inserted empty pages are suppressed. This option is active only if storing Writer documents.
107114

108115
### splitMode(?Sensiolabs\GotenbergBundle\Enumeration\SplitMode $splitMode)
109-
Either intervals or pages. (default None).
116+
Either intervals or pages.<br />
117+
118+
> [!TIP]
119+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
120+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
110121
111122
### splitSpan(string $splitSpan)
112-
Either the intervals or the page ranges to extract, depending on the selected mode. (default None).
123+
Either the intervals or the page ranges to extract, depending on the selected mode.<br />
124+
125+
> [!TIP]
126+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
127+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
113128
114129
### splitUnify(bool $bool)
115-
Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).
130+
Specify whether to put extracted pages into a single file or as many files as there are page ranges. Only works with pages mode. (default false).<br />
131+
132+
> [!TIP]
133+
> See: [https://gotenberg.dev/docs/routes#split-chromium](https://gotenberg.dev/docs/routes#split-chromium)
134+
> See: [https://gotenberg.dev/docs/routes#split-libreoffice](https://gotenberg.dev/docs/routes#split-libreoffice)
116135
117136
### type()
118137
### webhook(array $webhook)
119138
### webhookErrorRoute(string $route, array $parameters, ?string $method)
139+
> [!TIP]
140+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
141+
120142
### webhookErrorUrl(string $url, ?string $method)
143+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
144+
145+
> [!TIP]
146+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
147+
121148
### webhookExtraHeaders(array $extraHttpHeaders)
149+
Extra headers that will be provided to the webhook endpoint. May it either be Success or Error.<br />
150+
151+
> [!TIP]
152+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
153+
122154
### webhookRoute(string $route, array $parameters, ?string $method)
155+
> [!TIP]
156+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
157+
123158
### webhookUrl(string $url, ?string $method)
159+
Sets the webhook for cases of success.<br />Optionally sets a custom HTTP method for such endpoint among : POST, PUT or PATCH.<br />
160+
161+
> [!TIP]
162+
> See: [https://gotenberg.dev/docs/webhook](https://gotenberg.dev/docs/webhook)
163+

0 commit comments

Comments
 (0)