Appendix

This page is available in

Appendix

AVS Document Converter XML Formatting

Example of AVSDocumentConverterPro.xml file for conversion to PDF:

<?xml  version="1.0"  encoding="utf-8"?>
<conversion   formatType="PDF"   fileType="">
   <inputFiles>
      <file>..\Examples\docfile1.docx</file>
      <file>D:\Documents\docfile2.docx</file>
   </inputFiles>
   <inputFolders>
      <folder></folder>
      <filter>*.docx</filter>
      <includeSubfolders>false</includeSubfolders>
   </inputFolders>
   <outputFolder>%MYDOCUMENTS%\AVS4YOU\AVSDocumentConverter</outputFolder>
   <formatSettings>
      <pdf>
         <makeMerge>false</makeMerge>
         <permissions>
            <setPermissions>false</setPermissions>
            <owner>Owner</owner>
            <user>User</user>
            <restrictEditing>false</restrictEditing>
            <restrictPrinting>false</restrictPrinting>
            <restrictCopyingContent>false</restrictCopyingContent>
         </permissions>
      </pdf>
      <images>
         <jpeg>
            <quality>95</quality>
         </jpeg>
         <tiff>
            <compress>false</compress>
         </tiff>
      </images>
      <html>
         <richHtml>
            <addToolbar>false</addToolbar>
         </richHtml>
      </html>
      <txt>
         <encoding>UTF-8</encoding>
      </txt>
      <ebook>
         <makeMerge>false</makeMerge>
         <saveCover>true</saveCover>
         <epub>
            <embeddedFonts>true</embeddedFonts>
         </epub>
      </ebook>
      <watermark>
         <addWatermark>false</addWatermark>
         <text>WATERMARK   TEXT</text>
         <font>
            <name>Arial</name>
            <size>96</size>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
            <color>0</color>
         </font>
         <align>1</align>
         <opacity>40</opacity>
      </watermark>
   </formatSettings>
   <autostartConversion>true</autostartConversion>
   <minimizeForm>false</minimizeForm>
   <replaceFileAndDir>true</replaceFileAndDir>
   <finalAction>2</finalAction>
   <openOutputFolder>true</openOutputFolder>
</conversion>

The following tags and their parameters are available for AVS Document Converter XML syntax:

conversion

The main output file parameters:

formatType - output document format: PDF, DOC, DOCX, Image, HTML, ODT, RTF, TXT, eBook.
fileType - type of file: JPEG, TIFF, GIF, PNG for Image format; Plain HTML, Rich HTML, MHT for HTML format; ePub, FB2, Mobi for eBook format.

<conversion   formatType="PDF"   fileType="">
</conversion>

[Back to Top]

conversion > inputFiles > file

The path to the input file(s).

<conversion   formatType="PDF"   fileType="">
   <inputFiles>
      <file>D:\Documents\docfile1.docx</file>
      <file>D:\Documents\docfile2.docx</file>
   </inputFiles>
</conversion>

[Back to Top]

conversion > inputFolders

The path to the folder for the input file(s). The following subcategories are available here:

inputFolders > folder - the path to the folder where the input files are placed.
inputFolders > filter - the mask of the input files to be converted separated with semicolon.
inputFolders > includeSubfolders - either include the subfolders or not (possible values: true/false or 1/0).

<conversion   formatType="PDF"   fileType="">
   <inputFolders>
      <folder>D:\Video\</folder>
      <filter>*.docx</filter>
      <includeSubfolders>false</includeSubfolders>
   </inputFolders>
</conversion>

[Back to Top]

conversion > outputFolder

The path to the folder for the output file(s).

<conversion   formatType="PDF"   fileType="">
   <outputFolder>D:\Documents</outputFolder>
</conversion>

[Back to Top]

conversion > formatSettings > pdf

Parameters for conversion of files to the PDF format. The following subcategories are available here:

pdf > makeMerge - either merge the input files into one output file or not (possible values: true/false or 1/0).
pdf > permissions > setPermissions - either set permissions (enable restrictions for the file use) or not (possible values: true/false or 1/0).
pdf > permissions > owner - set the document owner password.
pdf > permissions > user - set the document user password.
pdf > permissions > restrictEditing - either restrict the document editing or not (possible values: true/false or 1/0).
pdf > permissions > restrictPrinting - either restrict the document printing or not (possible values: true/false or 1/0).
pdf > permissions > restrictCopyingContent - either restrict the document content copying or not (possible values: true/false or 1/0).

<conversion   formatType="PDF"   fileType="">
   <formatSettings>
      <pdf>
         <makeMerge>false</makeMerge>
         <permissions>
            <setPermissions>false</setPermissions>
            <owner>Owner</owner>
            <user>User</user>
            <restrictEditing>false</restrictEditing>
            <restrictPrinting>false</restrictPrinting>
            <restrictCopyingContent>false</restrictCopyingContent>
         </permissions>
      </pdf>
   </formatSettings>
</conversion>

[Back to Top]

conversion > formatSettings > images

Parameters for conversion of files to the JPEG and TIFF image formats. The following subcategories are available here:

images > jpeg > quality - output JPEG image file quality (possible values: 1-100 percentage range).

<conversion   formatType="Image"   fileType="JPEG">
   <formatSettings>
      <images>
         <jpeg>
            <quality>95</quality>
         </jpeg>
      </images>
   </formatSettings>
</conversion>

images > tiff > compress - either apply LZW compression to the output image file or not (possible values: true/false or 1/0).

<conversion   formatType="Image"   fileType="TIFF">
   <formatSettings>
      <images>
         <tiff>
            <compress>false</compress>
         </tiff>
      </images>
   </formatSettings>
</conversion>

[Back to Top]

conversion > formatSettings > html > richHtml > addToolbar

Either add the toolbar to the output file or not (possible values: true/false or 1/0).

<conversion   formatType="HTML"   fileType="Rich HTML">
   <formatSettings>
      <html>
         <richHtml>
            <addToolbar>false</addToolbar>
         </richHtml>
      </html>
   </formatSettings>
</conversion>

[Back to Top]

conversion > formatSettings > txt > encoding

The encoding used for the output text file (possible values: ANSI, UTF-8, Unicode).

<conversion   formatType="TXT"   fileType="">
   <formatSettings>
      <txt>
         <encoding>UTF-8</encoding>
      </txt>
   </formatSettings>
</conversion>

[Back to Top]

conversion > formatSettings > ebook

Parameters for conversion of files to the eBook format. The following subcategories are available here:

ebook > makeMerge - either merge the input files into one output file or not (possible values: true/false or 1/0).
ebook > saveCover - either save the cover into the output file or not (possible values: true/false or 1/0).
ebook > epub > embeddedFonts - either embed the fonts into the output file or not (possible values: true/false or 1/0).

<conversion   formatType="eBook"   fileType="ePub">
   <formatSettings>
      <ebook>
         <makeMerge>false</makeMerge>
         <saveCover>true</saveCover>
         <epub>
            <embeddedFonts>true</embeddedFonts>
         </epub>
      </ebook>
   </formatSettings>
</conversion>

[Back to Top]

conversion > formatSettings > watermark

Parameters for adding watermark text to the output file. The following subcategories are available here:

watermark > addWatermark - either add the watermark text to the output file or not (possible values: true/false or 1/0).
watermark > text - the watermark text that must be added to the output file.
watermark > font - the watermark font parameter:
- font > name - the name of the font used for the watermark.
- font > size - the size of the font used for the watermark in pixels (possible values: 1-999).
- font > bold - either the font used for the watermark must be bold or not (possible values: true/false or 1/0).
- font > italic - either the font used for the watermark must be italicized or not (possible values: true/false or 1/0).
- font > underline - either the text used for the watermark must be underlined or not (possible values: true/false or 1/0).
- font > strikeout - either the text used for the watermark must be struck through or not (possible values: true/false or 1/0).
- font > color - RGB color used for the watermark text (possible values: 0 for the black color - 16777215 for the white color).
watermark > align - the watermark text alignment (possible values: 1 - up-right, 2 - down-right, 3 - right, 4 - down).
watermark > opacity - the watermark text opacity (possible values: 0-100).

<conversion   formatType="PDF"   fileType="">
   <formatSettings>
      <watermark>
         <addWatermark>true</addWatermark>
         <text>WATERMARK   TEXT</text>
         <font>
            <name>Arial</name>
            <size>96</size>
            <bold>false</bold>
            <italic>false</italic>
            <underline>false</underline>
            <strikeout>false</strikeout>
            <color>0</color>
         </font>
         <align>1</align>
         <opacity>40</opacity>
      </watermark>
   </formatSettings>
</conversion>

[Back to Top]

conversion > autostartConversion

Either automatically start the conversion at the program startup or not (possible values: true/false or 1/0).

<conversion   formatType="PDF"   fileType="">
   <autostartConversion>true</autostartConversion>
</conversion>

[Back to Top]

conversion > minimizeForm

Either minimize the application window to taskbar at the program startup or not (possible values: true/false or 1/0).

Note: this parameter is ignored if the autostartConversion is set to false.

<conversion   formatType="PDF"   fileType="">
   <minimizeForm>false</minimizeForm>
</conversion>

[Back to Top]

conversion > replaceFileAndDir

Either automatically permit the program to replace files and folders in the output folder without the warning dialog or not (possible values: true/false or 1/0).

<conversion   formatType="PDF"   fileType="">
   <replaceFileAndDir>true</replaceFileAndDir>
</conversion>

[Back to Top]

conversion > finalAction

The application behavior after the conversion is finished (possible values: 1 - do nothing, 2 - close application, 3 - shutdown PC).

<conversion   formatType="PDF"   fileType="">
   <finalAction>2</finalAction>
</conversion>

[Back to Top]

conversion > openOutputFolder

Either automatically open the folder containing output files upon the conversion end or not (possible values: true/false or 1/0).

<conversion   formatType="PDF"   fileType="">
   <openOutputFolder>true</openOutputFolder>
</conversion>

[Back to Top]