Budget Book Version 1.0 Format

 

Budget Book is an .XML like document which defines the budget books structure. You can use any simple text editing software like Note Pad or a more extended .XML editing tool to modify files. There can be many Budget Books in a project. This is one of the primary concepts: utilizing the same data for producing different budget documents

<BookName="City Budget In Brief"Value=""Version="1.0">
  <ReferenceFiles>  
    <File Path="Data\budget.reference"/>
  </ReferenceFiles>
  <DataFiles>
    <File Path="Data\FundsCrosswalk.xlsx"/>
  </DataFiles>
  <Section Name="Main Document Section"
           TopMargin="1"BottomMargin="1"RightMargin="1"LeftMargin="1">
    <Section  Name="doc1"
              NodePath="doc1.docx"
              PageBreakAfter="True"/>
    <Section  Name="doc2"
              NodePath="doc2.docx"
              PageBreakAfter="True"/>
    <Exhibit  Name="Funds Exhibit"
              OutputPath="Exhibits"
              TopPartPath="Exhibits\Parts\Funds Exhibit - Top part.docx"
              XSLTPath="Exhibits\XSLTs\FundsExhibit.xslt" />
    <Section  Name="doc3"
              NodePath="doc3.docx"
              PageBreakAfter="True"/>
    </Section>
</Book>

 

Book - Attributes and Properties

 

Attribute

Description

Name

Name of the budget document.

Will be used as the name for newly generated document with the extension specific to the selected output format.  

Version

Version of the budget.book file.

We are planning to evolve book format in the future to allow flexibility, minimize impact to existing books and enforce uniformity.

StyleTemplate

Full path to the document that has a Normal Style template, which will be used across the book project.

Watermark

  BETA Watermark is empty by default. 

DraftFolder

  BETA Location of the Draft folder. Documents and exhibits are saved in this folder if output folder not specified. 
Default value is "Draft" folder relative from the main project folder. 

ExtractFolder

  BETA Location of the Extract folder.
Charts and other artifacts are extracted into this folder. 
Default value is "Extract" folder relative from the main project folder. 

TempFolder

  BETA Location of the Temp folder. Raw exhibits and other temporary files are stores in this folder. 
Default value is "Temp" folder relative from the main project folder.

DataOutputFolder

  BETA Location to the Data Output folder. Cached consolidated data file is stored in this folder.
Default value is "Temp" folder relative from the main project folder.



 

 

Section - Attributes and Properties

A section can group multiple sections and exhibits together to define a common attributes like margins or headers. 

Attribute

Description

Name

Name of the section in the budget book

CoverPage

When set to "True" it will indicate that section as the cover page. Cover pages don’t have headers and footers. We recommend using only one cover page in your document. Some of the older versions of MS Word and PDF might not recognize multiple cover pages.

StartOnOddPage

"True" when section should start on the Odd page. False by default. Note that this attribute would not add an automatic page break and would have an effect only if prior section has page break.

HeaderPath

Path and name of the document that has header template.

If information is not provided then application will inherit header path from parent document section. 

FooterPath

Path and name of the document that has footer template.

If information is not provided then application would inherit footer path from parent document section.

NewPageNumber

When this attribute has been specified for section, this section should restart numbering from the provided number.

MainTOCEntryName

Provides text that you want to appear in the corresponding table of contents entry. If value starts from C: or D: followed by numbers (from 1 through 5) then it should be included in to TOC at the specified by the number level.

NodePath

The path and file name of the document associated with this Section. This should be relative path from the main project folder.

PageBreakAfter

Specify if there should be a page break After the section. When this attribute is not specified then the section would continuously follow on from the prior section. Source document itself might have page breaks.

The page break is applicable only for the section where it is specified, page break  will not be inherited by a child sections.

Page break will be applied when section have NodePath attribute specified.

TopMargin, BottomMargin, RightMargin, LeftMargin

Margin in inches.

Specifying new values for a section would override values inherited from parent. If information is not provided then application will inherit margin settings from parent document section.

 

Exhibit - Attributes and Properties

 

Attribute

Description

OutputPath

Relative path to the folder where the generated exhibit document will be saved.

TopPartPath

Path to document that contains the exhibit top part. Optional parameter.

BottomPartPath

Path to  document that contains the exhibit bottom part. Optional parameter.

XSLTPath

Path to the XSL transformation script that would transform data specified in the book in to the HTML table that will become body of the exhibit document.

XSL Transformations (XSLT) Version 1.0 supported. 

Name

1. Name of the exhibit section in the budget book. 

2. Exhibit file name that will be saved in to output path. Extension if always .docx

CoverPage

When set to "true" it will indicate that section is the cover page. Cover pages don’t have headers and footers. We recommend using only one cover page in your document. Some of the older versions of MS Word and PDF might not recognize  multiple cover pages.

StartOnOddPage

"True" when section should start on the Odd page. False by default. Note that this attribute would not add automatic page break and would have an effect only if prior section has page break.

HeaderPath

Path and name of the document that has header template.

If information is not provided then application will inherit header path from parent document section. 

FooterPath

Path and name of the document that has footer template.

If information is not provided then application would inherit footer path from parent document section.

NewPageNumber

When this attribute has been specified for section then this section should restart numbering from provided number.

MainTOCEntryName

Provides text that you want to appear in the corresponding table of contents entry. If value starts from C: or D: followed by numbers (from 1 through 5) then it should be included in to TOC at the specified by the number level.

PageBreakAfter

Specify if there should be a page break After the exhibit section. When this attribute not specified then exhibit section would continuously follow prior section.

The top or bottom exhibit parts documents itself might have page breaks.

TopMargin, BottomMargin,
RightMargin, LeftMargin

Margin in inches.

Specifying new values for a section would override values inherited from parent. If information is not provided then application will inherit margin settings from parent document section.

 

ReferenceFiles - Attributes and Properties

The ReferenceFiles section includes the list of all reference files. 

Attribute/Property

Description

<File Path="">

Path to the reference file.    

The references from multiple files will be applied after the references have been found in data files, in the order in which, reference files are specified in the budget book file. For instance, in the example listed below, first the references from the local.reference file will be applied, then the references from the global.reference file will be applied, and finally from extra.reference file. 

  <ReferenceFiles>  
    <File Path="local.reference"/>
    <File Path="global.reference"/>
    <File Path="extra.reference"/>
  </ReferenceFiles>  

   

DataFiles - Attributes and Properties

The DataFiles section includes the list of all data files that will provide data for exhibits and references. 

Attribute/Property

Description

<File Path="">

Path to the data file.    

The data from multiple files will be combined into one consolidated data file, which will be used to produce exhibits. For instance, in the example listed below, first there are three crosswalks in MS Excel format, then the object class extract in XML format from accounting system, and finally data extract in XML format from database.

  <DataFiles>  
    <File Path="CrosswalkA.xlsx"/>
    <File Path="CrosswalkB.xlsx"/>
    <File Path="CrosswalkC.xlsx"/>
    <File Path="ObjectClasses.xml"/>
    <File Path="FinatialDataExtractFromDatabase.xml"/>
  </DataFiles>  

 

Additional Information

Quick Step Tutorial - includes samples of the many different books


Site Map | Printable View | © 2008 - 2017 Budget In Brief | Powered by mojoPortal | HTML 5 | CSS | Design by styleshout