DocBook.Utils
class DocBook.Utils extends %Library.RegisteredObject
Utility classMethod Inventory
- AfterLoadSets()
- ApplyMacros()
- CalculatedAddlProps()
- Classify()
- GetCleanedUpTagList()
- Indexable()
- Load()
- LoadBook()
- LoadDir()
- LoadMaster()
- LoadSet()
- LoadSets()
- ProcessConditionAttribute()
- ProcessDerivedTags()
- ProcessDerivedTagsFromFile()
- ProcessRankings()
- ProcessRankingsFromFile()
- ProcessTopid()
- RemoveArticle()
- RemoveBook()
- RemoveSet()
- ReplaceSet()
- ShowSearchDirs()
- StartsWith()
- UpdateTagsTable()
- XMLExport()
- XMLExportAll()
Methods
classmethod AfterLoadSets(verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
classmethod ApplyMacros(verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
This method is deprecated. Instead use code in the Utils package.
This method is deprecated. Instead use code in the Utils package.
Set up the material classificaton for the home page
This method is deprecated. Instead use code in the Utils package.
classmethod Indexable(title As %String = "")
This method is deprecated. Instead use code in the Utils package.
Load an individual doc file
This method is deprecated. Instead use code in the Utils package.
Load an entire book definition
classmethod LoadDir(subdir As cdata)
This method is deprecated. Instead use code in the Utils package.
Load every non-master file in the given directory
This method is deprecated. Instead use code in the Utils package.
Load the master file for the given directory
classmethod LoadSet(setname As cdata = "", main As cdata = "", multiprocess As %Boolean = 0) as %Status
This method is deprecated. Instead use code in the Utils package.
Load (reload) a set.
classmethod LoadSets(main As cdata = "", multiprocess As %Boolean = 0, verbose As %Boolean = 1) as %Status
This method is deprecated. Instead use code in the Utils package.
Reset and load the master documents.
This method is deprecated. Instead use code in the Utils package.
Iterates through all rows in the DocBook.book and DocBook.article tables.
For each book or article, this method finds the condition attribute for the given book or article
and then uses that to set the ExtraTags field for each row in DocBook.block
that belong to the given book or article. Also recurses through these lower-level
rows to find any additional condition attributes and add tags from them as well.
item is optional. If specified, it must be the blockid of a book or article; if you specify this, we process just that book or article.
classmethod ProcessDerivedTags(verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
classmethod ProcessDerivedTagsFromFile(filename As %String = "c:\0work\derivedtags.txt", verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
Given a derivedtags.txt file, updates the extraTags property for any affected block
classmethod ProcessRankings(verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
classmethod ProcessRankingsFromFile(filename As %String = "c:\0work\cache-rankings.txt", verbose As %Boolean = 0)
This method is deprecated. Instead use code in the Utils package.
Given a rankings file, updates the Rank property for all records in DocBook.block
This method is deprecated. Instead use code in the Utils package.
Called by ProcessConditionAttribute.
Given the id (not blockid) of a book or article, see if this record has a value for the condition
attribute, and if so, extract that value and update the ExtraTags field for this record and all
child records. Process child records in the same way.
This method is deprecated. Instead use code in the Utils package.
Remove an article from the database
This method is deprecated. Instead use code in the Utils package.
Remove a book from the database
This method is deprecated. Instead use code in the Utils package.
Remove a set from the database
This method is deprecated. Instead use code in the Utils package.
Replaces a set and its books.
This method is deprecated. Instead use code in the Utils package.
Show the search paths available
classmethod StartsWith(string As %String, fragment As %String, caseSensitive As %Boolean = 0) as %Boolean
This method is deprecated. Instead use code in the Utils package.
Generates the version info string for the DocBook database.
This is invoked when the database is built. This method is deprecated. Instead use code in the Utils package. Returns true if string starts with the given fragment.
This is invoked when the database is built. This method is deprecated. Instead use code in the Utils package. Returns true if string starts with the given fragment.
This method is deprecated. Instead use code in the Utils package.
Export a document as an xml document
Extracts all books and articles as singleton XML files into the specified directory.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()