Publish.FileScan

class Publish.FileScan

Used by the Utils.ExternalFiles::GeneratePDFIndex method. Use this class to get a dynamic object for use in generating the index.html files that accompany the PDFs. We create the object by scanning the paths and the files on them (and we consider the exclusions).

The object returned by the GetIndexObjectFromPath() method has the following properties:

• forJaJp -- this is either 0 or 1
• idlist -- this is an array of objects. Each object has the following properties:
  • DocBookId
  • title
  • subtitle
  • filename
  • PDFCategory -- this is either 2 (meaning that this PDF goes into the target /full/pdfs directory) or 3 (meaning that the PDF goes into the /full/pdfs directory AND the target /install/pdfs directory)
• setlist -- this is an array of objects. Each object has the following properties:
  • DocBookId
  • title
  • subtitle
  • booklist-- this is an array of objects. Each object has the following properties:
    • DocBookId
    • title
    • subtitle
    • filename
    • PDFCategory
• articlelist -- this is an array of objects. Each object has the following properties:
  • DocBookId
  • title
  • subtitle
  • filename
  • PDFCategory

Method Inventory

• ExportData()
• FilesAreJaJp()
• GetIndexObjectFromPath()

Methods

classmethod ExportData()

Assumes you have run BuildGlobalsForIndex()

classmethod FilesAreJaJp() as %Boolean

Returns 1 if we are loading doc from a Japanese source subbranch; otherwise returns 0.

classmethod GetIndexObjectFromPath(verbose As %Boolean = 0, forceRebuild As %Boolean = 1, onlyStatic As %Boolean = 0) as %DynamicObject