diff --git a/docs/WritePro/commands-legacy/wp-get-view-properties.md b/docs/WritePro/commands-legacy/wp-get-view-properties.md index 0344a3903833f6..4b817f1e149eee 100644 --- a/docs/WritePro/commands-legacy/wp-get-view-properties.md +++ b/docs/WritePro/commands-legacy/wp-get-view-properties.md @@ -41,7 +41,7 @@ The returned object contains all view properties of the 4D Write Pro area, along | wk resolution | dpi | Screen resolution for the contents of the 4D Write Pro area. Possible values: wk auto (0) Number greater than 1 | | wk spell enable | spellEnabled | Enables the auto spellcheck. Possible values: True/False | | wk visible background | visibleBackground | Displays both background images and background color (visible effect in Page or Embedded view mode only). Possible values: True/False | -| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | +| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True. If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | | wk visible footers | visibleFooters | Displays or exports the footers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible headers | visibleHeaders | Displays or exports the headers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible hidden characters | visibleHiddenChars | Displays invisible characters. Possible values: True/False | diff --git a/docs/WritePro/commands-legacy/wp-set-view-properties.md b/docs/WritePro/commands-legacy/wp-set-view-properties.md index 49722a06b93f4d..222cae5ca2b352 100644 --- a/docs/WritePro/commands-legacy/wp-set-view-properties.md +++ b/docs/WritePro/commands-legacy/wp-set-view-properties.md @@ -34,7 +34,7 @@ In *wpViewProps*, pass an object wherein each property is a view property that y | wk resolution | dpi | Screen resolution for the contents of the 4D Write Pro area. Possible values: wk auto (0) Number greater than 1 | | wk spell enable | spellEnabled | Enables the auto spellcheck. Possible values: True/False | | wk visible background and anchored elements | visibleBackground | Displays or exports background images/color, anchored images and text boxes (for display, visible effect in Page or Embedded view mode only). Possible values: True/False | -| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | +| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True. If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | | wk visible footers | visibleFooters | Displays or exports the footers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible headers | visibleHeaders | Displays or exports the headers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible hidden characters | visibleHiddenChars | Displays invisible characters. Possible values: True/False | diff --git a/docs/WritePro/commands/wp-export-document.md b/docs/WritePro/commands/wp-export-document.md index 943fcf6df6d4b4..d458b481fba761 100644 --- a/docs/WritePro/commands/wp-export-document.md +++ b/docs/WritePro/commands/wp-export-document.md @@ -36,7 +36,7 @@ You can omit the *format* parameter, in which case you need to specify the exten | -------------------- | ----- | ------------------ | | wk 4wp | 4 | 4D Write Pro document is saved in a native archive format (zipped HTML and images saved in a separate folder). 4D specific tags are included and 4D expressions are not computed. This format is particularly suitable for saving and archiving 4D Write Pro documents on disk without any loss. | | wk docx | 7 | .docx extension. 4D Write Pro document is saved in Microsoft Word format. Certified support for Microsoft Word 2010 and newer.
The document parts exported are: Note that some 4D Write Pro settings may not be available or may behave differently in Microsoft Word. | -| wk mime html | 1 | 4D Write Pro document is saved as standard MIME HTML with HTML documents and images embedded as MIME parts (encoded in base64). Expressions are computed and 4D specific tags and method links are removed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable for sending HTML emails with the command. | +| wk mime html | 1 | 4D Write Pro document is saved as standard MIME HTML with HTML documents and images embedded as MIME parts (encoded in base64). Expressions are computed and 4D specific tags and method links are removed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable for sending HTML emails. | | wk pdf | 5 | .pdf extension. 4D Write Pro document is saved in PDF format, based on Page view mode. The following metadata is exported in a PDF document: Title / Author / Subject / Content creator
**Notes**: | | wk svg | 8 | 4D Write Pro document page is saved in SVG format, based on Page view mode. **Note:** When exporting to SVG, you can only export one page at a time. Use the wk page index to specify which page to export. | | wk web page complete | 2 | .htm or .html extension. Document is saved as standard HTML and its resources are saved separately. 4D tags and links to 4D methods are removed and expressions are computed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable when you want to display a 4D Write Pro document in a web browser. | @@ -45,13 +45,13 @@ You can omit the *format* parameter, in which case you need to specify the exten * "4D specific tags" means 4D XHTML with a 4D namespace and 4D CSS styles. * For more information about the 4D Write Pro document format, refer to [.4wp document format](https://doc.4d.com/4Dv20/4D/20/Using-a-4D-Write-Pro-area.200-6229460.en.html#2895813). -* To view a list of known differences or incompatibility when using the .docx format, see [Importing and Exporting in .docx format](https://doc.4d.com/4Dv20/4D/20/Importing-and-Exporting-in-docx-format.200-6229466.en.html). +* To view a list of known differences or incompatibility when using the .docx format, see [Importing and Exporting in .docx format](../user-legacy/importing-and-exporting-in-docx-format.md). * For more information on exporting to SVG format, see [Exporting to SVG format](https://doc.4d.com/4Dv20/4D/20/Exporting-to-SVG-format.200-6229468.en.html). ### option parameter -Pass an [object](# "Data structured as a native 4D object") in *option* containing the values to define the properties of the exported document. The following properties are available: +Pass in *option* an object containing the values to define the properties of the exported document. The following properties are available: | Constant | Value | Comment | | ----------- | ------------------ | ---------------------------------------- | @@ -67,7 +67,7 @@ Pass an [object](# "Data structured as a native 4D object") in *option* containi | wk pdfa version | pdfaVersion | Exports PDF with conformance to a PDF/A version. For more information on PDF/A properties and versions, please refer to the [PDF/A page on Wikipedia](https://en.wikipedia.org/wiki/PDF/A). Possible values:
  • `wk pdfa2`: Exports to version "PDF/A-2"
  • `wk pdfa3`: Exports to version "PDF/A-3"
  • **Note:** On macOS, `wk pdfa2` may export to PDF/A-2 or PDF/A-3 or higher, depending on platform implementation. Also, `wk pdfa3` means "exports to *at least* PDF/A-3". On Windows, the output PDF file will always be equal to the desired conformance. | | wk recompute formulas | recomputeFormulas | Defines if formulas must be recomputed when exported. Possible values:
  • true - Default value. All formulas are recomputed
  • false - Do not recompute formulas
  • | | wk visible background and anchored elements | visibleBackground | Displays or exports background images/color, anchored images and text boxes (for display, visible effect in Page or Embedded view mode only). Possible values: True/False | -| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | +| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True. If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | | wk visible footers | visibleFooters | Displays or exports the footers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible headers | visibleHeaders | Displays or exports the headers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible references | visibleReferences | Displays or exports all 4D expressions inserted in the document as references. Possible values: True/False | @@ -95,7 +95,7 @@ The following table indicates the *option* available per export *format*: | wk visible references | \- | \- | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: false) | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: false) | | wk whitespace | \- | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: "pre-wrap") | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: "pre-wrap") | \- | -**Compatibility Note:** Passing a *longint* value in *option* is supported for compatibility reasons, but it is recommended to use an [object](# "Data structured as a native 4D object") parameter. +**Compatibility Note:** Passing a *longint* value in *option* is supported for compatibility reasons, but it is recommended to use an object parameter. ### wk files collection @@ -108,7 +108,7 @@ The wk files property allows you to [export a PDF with attachments](https://blog | mimeType | Text | Optional. If omitted, default value can usually be guessed from file extension; otherwise, "application/octet-stream" is used. If passed, make sure to use an ISO mime type, otherwise the exported file could be invalid. | | data | Text or BLOB | Mandatory if *file* property is missing | | file | 4D.File object | Mandatory if *data* property is missing, ignored otherwise. | -| relationship | Text | Optional. If omitted, default value is "Data". Possible values for Factur-X first file:for BASIC, EN 16931 or EXTENDED profiles: "Alternative", "Source" or "Data" ("Alternative" only for German invoice)for MINIMUM and BASIC WL profiles: "Data" only.for other profiles: "Alternative", "Source" or "Data" (with restrictions perhaps depending on country: see profile specification for more info about other profiles - for instance for RECHNUNG profile only "Alternative" is allowed)for other files (but Factur-X invoice xml file) : "Alternative", "Source", "Data", "Supplement" or "Unspecified"any other value generates an error. | +| relationship | Text | Optional. If omitted, default value is "Data". Possible values for Factur-X first file: | If the *option* parameter also contains a wk factur x property, then the first element of the wk files collection must be the Factur-X (ZUGFeRD) invoice xml file (see below). @@ -269,8 +269,8 @@ WP EXPORT DOCUMENT(WParea; $file; wk docx; $options) ## See also [4D QPDF (Component) - PDF Get attachments](https://github.com/4d/4D-QPDF)
    -[Exporting to HTML and MIME HTML formats](https://doc.4d.com/4Dv20/4D/20/Exporting-to-HTML-and-MIME-HTML-formats.200-6229467.en.html)
    -[Importing and Exporting in .docx format](https://doc.4d.com/4Dv20/4D/20/Importing-and-Exporting-in-docx-format.200-6229466.en.html)
    +[Exporting to HTML and MIME HTML formats](../user-legacy/exporting-to-html-and-mime-html-formats.md)
    +[Importing and Exporting in .docx format](../user-legacy/importing-and-exporting-in-docx-format.md)
    [Blog post - 4D Write Pro: Electronic invoice generation](https://blog.4d.com/4d-write-pro-electronic-invoice-generation)
    [Blog post - 4D Write Pro: Export to PDF with enclosures](https://blog.4d.com/4d-write-pro-export-to-pdf-with-enclosures)
    [WP EXPORT VARIABLE](wp-export-variable.md)
    diff --git a/docs/WritePro/commands/wp-export-variable.md b/docs/WritePro/commands/wp-export-variable.md index e7ba43a423d5e7..9f938ac86b1028 100644 --- a/docs/WritePro/commands/wp-export-variable.md +++ b/docs/WritePro/commands/wp-export-variable.md @@ -35,7 +35,7 @@ In the *format* parameter, pass a constant from the *4D Write Pro Constants* the | ------------------- | ------- | ----- | ------------| | wk 4wp | Integer | 4 | 4D Write Pro document is saved in a native archive format (zipped HTML and images saved in a separate folder). 4D specific tags are included and 4D expressions are not computed. This format is particularly suitable for saving and archiving 4D Write Pro documents on disk without any loss. | | wk docx |Integer | 7 | .docx extension. 4D Write Pro document is saved in Microsoft Word format. Certified support for Microsoft Word 2010 and newer.
    The document parts exported are: Note that some 4D Write Pro settings may not be available or may behave differently in Microsoft Word. | -| wk mime html | Integer | 1 | 4D Write Pro document is saved as standard MIME HTML with HTML documents and images embedded as MIME parts (encoded in base64). Expressions are computed and 4D specific tags and method links are removed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable for sending HTML emails with the command. | +| wk mime html | Integer | 1 | 4D Write Pro document is saved as standard MIME HTML with HTML documents and images embedded as MIME parts (encoded in base64). Expressions are computed and 4D specific tags and method links are removed. Only text boxes anchored to embedded view are exported (as divs). This format is particularly suitable for sending HTML emails. | | wk pdf | Integer | 5 | .pdf extension. 4D Write Pro document is saved in PDF format, based on Page view mode. The following metadata is exported in a PDF document: Title Author Subject Content creator **Notes**: Expressions are automatically frozen when document is exported Links to methods are NOT exported | | wk svg | Integer | 8 | 4D Write Pro document page is saved in SVG format, based on Page view mode. **Note:** When exporting to SVG, you can only export one page at a time. Use the wk page index to specify which page to export. | | wk web page html 4D | Integer | 3 | 4D Write Pro document is saved as HTML and includes 4D specific tags; each expression is inserted as a non-breaking space. Since this format is lossless, it is appropriate for storing purposes in a text field. | @@ -44,13 +44,13 @@ In the *format* parameter, pass a constant from the *4D Write Pro Constants* the * "4D specific tags" means 4D XHTML with a 4D namespace and 4D CSS styles. * For more information about the 4D Write Pro document format, refer to [.4wp document format](https://doc.4d.com/4Dv20/4D/20/Using-a-4D-Write-Pro-area.200-6229460.en.html#2895813). -* To view a list of known differences or incompatibility when using the .docx format, see [Importing and Exporting in .docx format](https://doc.4d.com/4Dv20/4D/20/Importing-and-Exporting-in-docx-format.200-6229466.en.html). +* To view a list of known differences or incompatibility when using the .docx format, see [Importing and Exporting in .docx format](../user-legacy/importing-and-exporting-in-docx-format.md). * When exporting to SVG format with this command, images are embedded in base64 format. * For more information on exporting to SVG format, see [Exporting to SVG format](https://doc.4d.com/4Dv20/4D/20/Exporting-to-SVG-format.200-6229468.en.html). ### option parameter -Pass an [object](# "Data structured as a native 4D object") in *option* containing the values to define the properties of the exported document. The following properties are available: +Pass in *option* an object containing the values to define the properties of the exported document. The following properties are available: | Constant | Value | Comment | | ----------- | ------------------ | ---------------------------------------- | @@ -66,7 +66,7 @@ Pass an [object](# "Data structured as a native 4D object") in *option* containi | wk pdfa version | pdfaVersion | Exports PDF with conformance to a PDF/A version. For more information on PDF/A properties and versions, please refer to the [PDF/A page on Wikipedia](https://en.wikipedia.org/wiki/PDF/A). Possible values:
  • `wk pdfa2`: Exports to version "PDF/A-2"
  • `wk pdfa3`: Exports to version "PDF/A-3"
  • **Note:** On macOS, `wk pdfa2` may export to PDF/A-2 or PDF/A-3 or higher, depending on platform implementation. Also, `wk pdfa3` means "exports to *at least* PDF/A-3". On Windows, the output PDF file will always be equal to the desired conformance. | | wk recompute formulas | recomputeFormulas | Defines if formulas must be recomputed when exported. Possible values:
  • true - Default value. All formulas are recomputed
  • false - Do not recompute formulas
  • | | wk visible background and anchored elements | visibleBackground | Displays or exports background images/color, anchored images and text boxes (for display, visible effect in Page or Embedded view mode only). Possible values: True/False | -| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | +| wk visible empty images | visibleEmptyImages | Displays or exports a default black rectangle for images that cannot be loaded or computed (empty images or images in an unsupported format). Possible values: True/False. Default value: True. If value is False, missing image elements will not be displayed at all even if they have borders, width, height, or background; this may impact the page layout for inline images. | | wk visible footers | visibleFooters | Displays or exports the footers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible headers | visibleHeaders | Displays or exports the headers (for display, visible effect in Page view mode only). Possible values: True/False | | wk visible references | visibleReferences | Displays or exports all 4D expressions inserted in the document as references. Possible values: True/False | @@ -94,7 +94,7 @@ The following table indicates the *option* available per export *format*: | wk visible references | \- | \- | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: false) | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: false) | | wk whitespace | \- | \- | ![](../../assets/en/WritePro/commands/pict5058606.en.png) (default: "pre-wrap") | \- | \- | \- | -**Compatibility Note:** Passing a *longint* value in *option* is supported for compatibility reasons, but it is recommended to use an [object](# "Data structured as a native 4D object") parameter. +**Compatibility Note:** Passing a *longint* value in *option* is supported for compatibility reasons, but it is recommended to use an object parameter. ## Example 1 @@ -159,6 +159,6 @@ To export the first page of a 4D Write Pro as SVG in a Text variable and hide th [4D QPDF (Component) - PDF Get attachments](https://github.com/4d/4D-QPDF) [Blog post - 4D Write Pro: Electronic invoice generation](https://blog.4d.com/4d-write-pro-electronic-invoice-generation) [Blog post - 4D Write Pro: Export to PDF with enclosures](https://blog.4d.com/4d-write-pro-export-to-pdf-with-enclosures) -[Exporting to HTML and MIME HTML formats](https://doc.4d.com/4Dv20/4D/20/Exporting-to-HTML-and-MIME-HTML-formats.200-6229467.en.html)
    -[Importing and Exporting in .docx format](https://doc.4d.com/4Dv20/4D/20/Importing-and-Exporting-in-docx-format.200-6229466.en.html)
    +[Exporting to HTML and MIME HTML formats](../user-legacy/exporting-to-html-and-mime-html-formats.md)
    +[Importing and Exporting in .docx format](../user-legacy/importing-and-exporting-in-docx-format.md)
    [WP EXPORT DOCUMENT](../commands/wp-export-document) diff --git a/docs/WritePro/commands/wp-get-style-sheet.md b/docs/WritePro/commands/wp-get-style-sheet.md index 75a975d5558ba7..79caf12725323f 100644 --- a/docs/WritePro/commands/wp-get-style-sheet.md +++ b/docs/WritePro/commands/wp-get-style-sheet.md @@ -52,7 +52,8 @@ To retrieve the "Main title" style sheet: var $styleSheet : Object $styleSheet:=WP Get style sheet(wpArea;"Main title") - If($styleSheet=Null) // check if the style sheet exists//if not create it + If($styleSheet=Null) // check if the style sheet exists + //if not create it $styleSheet:=WP New style sheet(wpArea;wk type paragraph;"Main title") End if ``` diff --git a/docs/WritePro/commands/wp-import-document.md b/docs/WritePro/commands/wp-import-document.md index aed9374c5c6436..a1899e69d09a58 100644 --- a/docs/WritePro/commands/wp-import-document.md +++ b/docs/WritePro/commands/wp-import-document.md @@ -23,15 +23,15 @@ The **WP Import document** command