History of phpgedview-XMLReport_Structure
Version 3 | Current version | |
---|---|---|
This is taken from the phpgedview wiki but will be expanded to allow additional functions for managing a wider range for reports. PGVReportThe root node that starts a PGV report template.
PGVRTitleThe title of this report. The title will appear in the list menu items.PGVRDescriptionA textual description of this report.PGVRInputSetup an input variable for the UI which will make the user input available as a variable later in the report. Attribute Description
PGVRStyleSetup an text style that text elements may reference to set the font style used when they are rendered. This is very similar to class stylesheets in HTML. The fonts that are available to you are the 12 fonts that come standard with Adobe Acrobat and the LucidaSans font included with the project. Note that to avoid including the font in the PDF report, the LucidaSans font will be interchanged with Arial for reports that do not contain any special characters. For reports that do contain special characters, only the LucidaSans font can be used.
==PGVRDoc==This is the main tag that signals the start of the report document.
==PGVRvar==Lookup and return the value of the given variable. The variable can be one of the many internal PGV variables, one of the user input variables, or a variable set with PGVRSetVar
==PGVRvarLetter==This is the same as the PGVRvar tag, except that it only returns the first letter of the variable.
==PGVRSetVar==Set an internal variable that can be used in this report. Variable can be referenced using the PGVRvar tag, or in an attribute value by prepending a $ in front of the variable name (ie. id="$pid")
==PGVRif==Setup a condition where the children of this node will only be processed if the value of the condition attribute evaluates to true.
==PGVRHeader==Setup a header that will be placed at the top of every page. ==PGVRBody== Start the main body of the document. The body will create new pages as content flows over the current page.==PGVRFooter==Setup a footer that will be placed at the bottom of every page.==PGVRPageHeader==Setup a header that will be printed at the top of the page whenever the body flows onto a new page. The PGVRPageHeader will be printed underneath the PGVRHeader. This is allows you to have a custom header for different people or families as information flows onto succeeding pages. !!==PGVRFootnote==This sets up a footnote in the document. Each unique footnote is numbered and that number is printed with a link to the footnote text, which is printed whenever the PGVRFootnoteTexts tag appears. ==PGVRFootnoteTexts==Print all of the footnotes setup while processing the document.==PGVRCell==The PGVRCell is the most basic text block that can be used in a report. It differs from the PGVRTextBox in that it can only have one style of text. Because of this you will often see PGVRTextBox used more often than PGVRCell. Text in a PGVRCell will wrap to the width of the cell.
==PGVRTextBox==The PGVRTextBox is very similar to PGVRCell except that it may have PGVRText children which may each have their own style.
==PGVRText==The PGVRText element must come inside a PGVRTextBox element and will render the text at the current document position according to the given style.
==PGVRList==Iterate through a list of level 0 records. The child elements contained in the PGVRList tag will be repeated for ever record in the list. The list can be filtered through the filter attributes. Any number of filters can be applied. With each iteration, the gedcom context is changes to the next record in the list.
==PGVRRelatives==Find all persons who are related to a given individual. With each iteration, the gedcom context is changed to the next record in the list. Attributes:
==PGVRGedcom==Set the current gedcom record context. All children tags will be referenced around the gedcom record selected using the "id" attribute"
==PGVRRepeatTag== Iterate across all of the Gedcom tags in the given in the "tag" attribute that are found in the current Gedcom context. With each iteration the current gedcom context is changes to the next matching tag's subrecord.
==PGVRFacts==Iterate across all of the level +1 subrecords in the current gedcom context. This is useful for iterating through all of the facts in an individual or family record. The tags that will be iterated across can be filtered using the "ignore" attribute. It is often desirable to print the family with spouse facts along with the person facts. The "families" attribute allows you to turn this behavior on or off.
==PGVRGetPersonName==Get the name of the person whose XREF id is given in the "id" attribute.
==PGVRGedcomValue==Get the value of a Gedcom tag. You can specify descendant tags by seperating them with colons (:). For example, a person's birthdate would be "BIRT:DATE". The birth place would be "BIRT:PLAC". Attribute Description tag The Gedcom tag to get the value from.==PGVRLine==Draw a line on the page.
==PGVRImage==Place an image on the page.
==PGVRHighlightedImage==Place the primary object image on the page. This would be the same image that is shown on the PGV charts.
==PGVRNow==Print the current date according to the selected language rules. !==PGVRPageNum== Print the current page number.==PGVRTotalPages==Print the total number of pages in the resulting document.==PGVRListTotal==Print the totals found in the filtered PGVRList.==br==Print a new line break. | This is taken from the phpgedview wiki but will be expanded to allow additional functions for managing a wider range for reports. PGVReportThe root node that starts a PGV report template.
PGVRTitleThe title of this report. The title will appear in the list menu items.PGVRDescriptionA textual description of this report.PGVRInputSetup an input variable for the UI which will make the user input available as a variable later in the report. Attribute Description
PGVRStyleSetup an text style that text elements may reference to set the font style used when they are rendered. This is very similar to class stylesheets in HTML. The fonts that are available to you are the 12 fonts that come standard with Adobe Acrobat and the LucidaSans font included with the project. Note that to avoid including the font in the PDF report, the LucidaSans font will be interchanged with Arial for reports that do not contain any special characters. For reports that do contain special characters, only the LucidaSans font can be used.
PGVRDocThis is the main tag that signals the start of the report document.
PGVRvarLookup and return the value of the given variable. The variable can be one of the many internal PGV variables, one of the user input variables, or a variable set with PGVRSetVar
PGVRvarLetterThis is the same as the PGVRvar tag, except that it only returns the first letter of the variable.
PGVRSetVarSet an internal variable that can be used in this report. Variable can be referenced using the PGVRvar tag, or in an attribute value by prepending a $ in front of the variable name (ie. id="$pid")
PGVRifSetup a condition where the children of this node will only be processed if the value of the condition attribute evaluates to true.
PGVRHeaderSetup a header that will be placed at the top of every page.PGVRBodyStart the main body of the document. The body will create new pages as content flows over the current page.PGVRFooterSetup a footer that will be placed at the bottom of every page.PGVRPageHeaderSetup a header that will be printed at the top of the page whenever the body flows onto a new page. The PGVRPageHeader will be printed underneath the PGVRHeader. This is allows you to have a custom header for different people or families as information flows onto succeeding pages.PGVRFootnoteThis sets up a footnote in the document. Each unique footnote is numbered and that number is printed with a link to the footnote text, which is printed whenever the PGVRFootnoteTexts tag appears.PGVRFootnoteTextsPrint all of the footnotes setup while processing the document.PGVRCellThe PGVRCell is the most basic text block that can be used in a report. It differs from the PGVRTextBox in that it can only have one style of text. Because of this you will often see PGVRTextBox used more often than PGVRCell. Text in a PGVRCell will wrap to the width of the cell.
PGVRTextBoxThe PGVRTextBox is very similar to PGVRCell except that it may have PGVRText children which may each have their own style.
PGVRTextThe PGVRText element must come inside a PGVRTextBox element and will render the text at the current document position according to the given style.
PGVRListIterate through a list of level 0 records. The child elements contained in the PGVRList tag will be repeated for ever record in the list. The list can be filtered through the filter attributes. Any number of filters can be applied. With each iteration, the gedcom context is changes to the next record in the list.
PGVRRelativesFind all persons who are related to a given individual. With each iteration, the gedcom context is changed to the next record in the list. Attributes:
PGVRGedcomSet the current gedcom record context. All children tags will be referenced around the gedcom record selected using the "id" attribute"
PGVRRepeatTagIterate across all of the Gedcom tags in the given in the "tag" attribute that are found in the current Gedcom context. With each iteration the current gedcom context is changes to the next matching tag's subrecord.
PGVRFactsIterate across all of the level +1 subrecords in the current gedcom context. This is useful for iterating through all of the facts in an individual or family record. The tags that will be iterated across can be filtered using the "ignore" attribute. It is often desirable to print the family with spouse facts along with the person facts. The "families" attribute allows you to turn this behavior on or off.
PGVRGetPersonNameGet the name of the person whose XREF id is given in the "id" attribute.
PGVRGedcomValueGet the value of a Gedcom tag. You can specify descendant tags by seperating them with colons (:). For example, a person's birthdate would be "BIRT:DATE". The birth place would be "BIRT:PLAC". Attribute Description tag The Gedcom tag to get the value from.PGVRLineDraw a line on the page.
PGVRImagePlace an image on the page.
PGVRHighlightedImagePlace the primary object image on the page. This would be the same image that is shown on the PGV charts.
PGVRNowPrint the current date according to the selected language rules.PGVRPageNumPrint the current page number.PGVRTotalPagesPrint the total number of pages in the resulting document.PGVRListTotalPrint the totals found in the filtered PGVRList.brPrint a new line break. |