Changes between Initial Version and Version 1 of DocManualprint


Ignore:
Timestamp:
Oct 7, 2010, 1:12:41 PM (8 years ago)
Author:
traffin
Comment:

Printing parameters in XML file

Legend:

Unmodified
Added
Removed
Modified
  • DocManualprint

    v1 v1  
     1[DocManual >> Back to manual ] 
     2[[TOC]] 
     3 
     4= Printing settings = 
     5Define printing settings via /config/.../print.xml 
     6 
     7== Special settings == 
     8 
     9Everywhere you can write HTML in this file, you can use special parameters that will be automatically replaced. 
     10 
     11=== Predefined variables === 
     12 
     13In the following parts, you can use those predefined variables: 
     14 * {{{$$printTitle}}}: title 
     15 * {{{$$printScale}}}: scale 
     16 * {{{$$printLegend}}}: legend 
     17 * {{{$$printUrlList[0]}}}: map image 
     18 * {{{$$printUrlList[1]}}}: refmap image 
     19 * {{{$$printUrlList[2]}}}: scalebar image 
     20 
     21=== Translations === 
     22 
     23All variable written like that {{{@[variable_name]@}}} will be automatically translated. 
     24 
     25== Dialog window == 
     26 
     27The HTML code of the window is in {{{print/printdgl}}}. 
     28 
     29== PDF output == 
     30 
     31All settings are in {{{print/settings/pdf}}}. 
     32 
     33=== internal settings === 
     34 * author 
     35 * pdftitle 
     36 
     37=== font === 
     38 * defFont 
     39 * defFontSize 
     40 * defFontColor 
     41 
     42=== top part === 
     43 * top_height 
     44 * top_color, top_bgcolor 
     45 * top_logo 
     46 * title_xoffs, title_yoffs 
     47 * additionnalTitle/before (text, textFont, textSize, textColor, textBgColor) 
     48 * additionnalTitle/after(text, textFont, textSize, textColor, textBgColor) 
     49 
     50=== small customization === 
     51 * printCategory 
     52 * refmap_bgcolor 
     53 * scaletxt_bgcolor 
     54 
     55=== Defining format: legend and layout definition === 
     56 
     57Each {{{format}}} tag define the available layouts for each paper size and orientation. The settings are: 
     58 * width, height: size of the map image 
     59 * legendposition: layout type 
     60  * B: bottom, line by line (first line with one or two columns, then second line with one or two columns, ...) 
     61  * BC: bottom in columns (first column, then second column, ...) 
     62  * R: on the right 
     63  * imgbr: image on the bottom right corner (above map image) 
     64  * none: no legend 
     65  * full: ??? 
     66 * legendNumColumns: number of columns to use for case R (only if legend requires more than 1 page), B and BC 
     67 * type: value to specify in the print dialog. 
     68 
     69 
     70== HTML output == 
     71 
     72The HTML code for output is in {{{print/html}}} and available styles to use for each format are in {{{print/settings/html}}}. 
     73 
     74 
     75== Complete example == 
     76 
     77{{{ 
     78<?xml version="1.0" encoding="UTF-8"?> 
     79 
     80<print> 
     81    <settings> 
     82        <printtitle></printtitle> 
     83         
     84        <!-- Settings for HTML print output --> 
     85        <html> 
     86            <format papersize="A4" orientation="P"> 
     87                <map width="620" height="540" type="normal" /> 
     88            </format> 
     89             
     90            <format papersize="A4" orientation="L"> 
     91                <map width="620" height="540" type="normal" css="templates/print/a4l.css"/> 
     92            </format> 
     93             
     94            <format papersize="A3" orientation="P"> 
     95                <map width="620" height="540" type="normal" css="templates/print/a3p.css"/> 
     96            </format> 
     97             
     98            <format papersize="A3" orientation="L"> 
     99                <map width="620" height="540" type="normal" css="templates/print/a3l.css"/> 
     100            </format> 
     101        </html> 
     102         
     103         
     104        <!-- Settings for PDF print output --> 
     105        <pdf> 
     106            <author>Armin Burger</author> 
     107            <pdftitle>p.mapper</pdftitle> 
     108             
     109            <defFont>FreeSans</defFont> 
     110            <defFontSize>9</defFontSize> 
     111            <defFontColor>0,0,0</defFontColor> 
     112             
     113            <printCategory>1</printCategory> 
     114 
     115            <top_height>30</top_height> 
     116            <top_color>255,255,255</top_color> 
     117            <top_bgcolor>51,102,153</top_bgcolor> 
     118            <refmap_bgcolor>255,255,255</refmap_bgcolor> 
     119            <scaletxt_bgcolor>255,255,255</scaletxt_bgcolor> 
     120            <top_logo>./images/logos/logo.png</top_logo> 
     121                         
     122            <title_xoffs>150</title_xoffs> 
     123            <title_yoffs></title_yoffs>             
     124 
     125            <additionnalTitle> 
     126                <before> 
     127                        <text></text> 
     128                        <textFont>FreeSans</textFont> 
     129                        <textSize>8</textSize> 
     130                        <textColor>0,0,0</textColor> 
     131                        <textBgColor>255,255,255</textBgColor> 
     132                </before> 
     133                <after> 
     134                        <text></text> 
     135                        <textFont>FreeSans</textFont> 
     136                        <textSize>8</textSize> 
     137                        <textColor>0,0,0</textColor> 
     138                        <textBgColor>255,255,255</textBgColor> 
     139                </after> 
     140            </additionnalTitle> 
     141 
     142            <format papersize="A4" orientation="P"> 
     143                <map width="740" height="770" legendposition="B" type="normal" legendNumColumns="2"/> 
     144                <map width="740" height="770" legendposition="BC" type="legColumns" legendNumColumns="2"/> 
     145                <map width="550" height="1040" legendposition="R" type="legRight" legendNumColumns="2"/> 
     146                <map width="740" height="1040" legendposition="imgbr" type="imgbr" img="./images/logos/logo.png" imgwidth="116" imgheight="230" /> 
     147                <map width="740" height="1040" legendposition="none" type="nolegend" /> 
     148                <map width="750" height="540" type="full"/> 
     149            </format> 
     150             
     151            <format papersize="A4" orientation="L"> 
     152                <map width="1080" height="540" legendposition="B" type="normal" legendNumColumns="3"/> 
     153                <map width="1080" height="540" legendposition="BC" type="legColumns" legendNumColumns="3"/> 
     154                <map width="890" height="720" legendposition="R" type="legRight" legendNumColumns="3"/> 
     155                <map width="1080" height="720" legendposition="imgbr" type="imgbr" img="./images/logos/logo.png" imgwidth="116" imgheight="230" /> 
     156                <map width="1080" height="720" legendposition="none" type="nolegend" /> 
     157            </format> 
     158             
     159            <format papersize="A3" orientation="P"> 
     160                <map width="1080" height="1300" legendposition="B" type="normal" legendNumColumns="3"/> 
     161                <map width="1080" height="1300" legendposition="BC" type="legColumns" legendNumColumns="3"/> 
     162                <map width="860" height="1500" legendposition="R" type="legRight" legendNumColumns="3"/> 
     163                <map width="1080" height="1500" legendposition="imgbr" type="imgbr" img="./images/logos/logo.png" imgwidth="116" imgheight="230" /> 
     164                <map width="1080" height="1500" legendposition="none" type="nolegend" /> 
     165            </format> 
     166             
     167            <format papersize="A3" orientation="L"> 
     168                <map width="1540" height="870" legendposition="B" type="normal" legendNumColumns="4"/> 
     169                <map width="1540" height="870" legendposition="BC" type="legColumns" legendNumColumns="4"/> 
     170                <map width="1340" height="1040" legendposition="R" type="legRight" legendNumColumns="4"/> 
     171                <map width="1540" height="1040" legendposition="imgbr" type="imgbr" img="./images/logos/logo.png" imgwidth="116" imgheight="230" /> 
     172                <map width="1540" height="1040" legendposition="none" type="nolegend" /> 
     173            </format> 
     174        </pdf>     
     175    </settings> 
     176     
     177    <html> 
     178        <body>     
     179            <div id="print_main"> 
     180                <!-- 
     181                    predefined variables: $$printTitle, $$printScale, $$printLegend 
     182                                          $$printUrlList[0], $$printUrlList[1], $$printUrlList[2] 
     183                --> 
     184                 
     185                <div id="print_titlebar"> 
     186                    <div id="print_logo_header"><img src="images/logos/logo.png" alt="logo" /></div> 
     187                    <div id="print_title_text">$$printTitle</div> 
     188                </div> 
     189                <div id="print_content"> 
     190                        <div id="print_mapzone"> 
     191                            <div id="print_map_image"><img src="$$printUrlList[0]" alt="map" /></div> 
     192                            <div id="print_map_refimage"><img src="$$printUrlList[1]" alt="refmap" /></div> 
     193                            <div id="print_map_scalebar"><img src="$$printUrlList[2]" alt="scalebar" /></div> 
     194                        </div> 
     195                        
     196                        <div id="print_scale_text">@[Scale]@ 1: $$printScale</div> 
     197 
     198                        <div id="print_legendzone"> 
     199                            <div id="print_legend_table">$$printLegend</div> 
     200                        </div> 
     201                </div> 
     202            </div> 
     203        </body> 
     204    </html>     
     205     
     206    <printdlg> 
     207        <div id="printdlg" class="printdlg"> 
     208            <div class="printdlg_main" style="display:inline"> 
     209                <div>@[Print Settings]@</div> 
     210                <div style="position:absolute; top:25px; right:15px"><img src="images/print.gif" alt="ico" width="35" height="35" /></div> 
     211            </div> 
     212 
     213            <div> 
     214                @[Print Title]@ 
     215                <input type="text" name="printtitle" size="30" value="$$printTitle" /> 
     216            </div> 
     217 
     218            <div>@[Scale]@ 1: <input type="text" name="printscale" size="10" value="$$printScale" /></div> 
     219            <div> 
     220                <input type="checkbox" name="printrefmap" value="on" checked="checked">@[With Overview Map]@</input> 
     221            </div> 
     222 
     223            <div class="printdlg_button"> 
     224                <input id="printdlg_button_advanced" type="button"  value="@@Advanced"  onclick="PM.Dlg.printShowAdvanced()" /> 
     225                <input id="printdlg_button_normal" type="button"  value="@@Standard"  onclick="PM.Dlg.printHideAdvanced()" style="display:none"/> 
     226            </div> 
     227 
     228            <div class="printdlg_advanced_hidden" style="display:none"> 
     229                <input type="checkbox" name="docformat" value="pdf" checked="checked">@[Create PDF Document]@</input> 
     230            </div> 
     231 
     232            <div class="printdlg_advanced"> 
     233                <label for="papersize">@[Paper size]@</label> 
     234                        <select name="papersize"> 
     235                                <option value="A4" selected="selected">A4</option> 
     236                                <option value="A3">A3</option> 
     237                        </select> 
     238            </div> 
     239             
     240            <div class="printdlg_advanced"> 
     241                        <label for="orientation">@[Page orientation]@</label> 
     242                        <select name="orientation"> 
     243                                <option value="P" selected="selected">@[Portrait]@</option> 
     244                                <option value="L">@[Landscape]@</option> 
     245                        </select> 
     246            </div> 
     247             
     248            <div class="printdlg_advanced"> 
     249                        <label for="maptype">@[Legend]@</label> 
     250                        <select name="maptype"> 
     251                                <option value="normal" selected="selected">@[printLegendBottom]@</option> 
     252                                <option value="imgbr">@[printLegendImage]@</option> 
     253                                <option value="legColumns">@[printLegendColumns]@</option> 
     254                                <option value="legRight">@[printLegendRight]@</option> 
     255                                <option value="nolegend">@[printLegendNone]@</option> 
     256                        </select> 
     257            </div> 
     258 
     259            <div class="printdlg_button" style="text-align:center"> 
     260                <input type="button"  value="@@Create Print Page"  onclick="submit();$('#pmDlgContainer').hide()" /> 
     261            </div> 
     262        </div> 
     263    </printdlg> 
     264</print> 
     265}}}