Skip to main content

Utils.Setup.Dirs

class Utils.Setup.Dirs extends %Library.RegisteredObject

Setup methods responsible for making directories as they should be

Method Inventory

Methods

classmethod CopyAlgoliaCSP(where As %String = "docbook", verbose As %Boolean = 1) as %Status
Recopy additional files for Algolia search. Where is the case-sensitive name of a subdirectory of /csp

For example where can be docbook or docbookj or documatic

classmethod CopyBetterZenJS(verbose As %Boolean = 1)
classmethod CopyBetterZenJSACTUAL(verbose As %Boolean = 1)
classmethod CopyCSPBrokerImages(verbose As %Boolean = 1) as %Status
Copy all files within the current instance's /csp/broker/images directory to the current DocBook images subdirectory.
classmethod CopyCSPBrokerImagesToDirectory(destination As %String, verbose As %Boolean = 1) as %Status
Copy all files within the current instance's /csp/broker/images directory to the destination directory specified.
classmethod CopyCSPBrokerToDirectory(destination As %String, force As %Boolean = 0, verbose As %Boolean = 1) as %Status
Copy all files within the current instance's /csp/broker directory to the destination directory specified. By default, copying will be skipped if this operation has already been done for the given destination - set the force argument to true to copy regardless.
classmethod CopyCSPDoctypes(verbose As %Boolean = 0) as %Boolean

Copy only the /doctypes directory within CSP from the Perforce root to the DOCBOOK (or DOCBOOKJ, as appropriate) CSP directory.

Returns a boolean: true for success, false for failure, rather than a %Status (as does ##class(%File).CopyDir(), which is used here).

Not necessary to run this if also running ..MakeDocBookCSPDir(). This is a helper method to use in specific cases where we need this particular directory but cannot yet run MakeDocBookCSPDir due to other dependencies.

classmethod CopyCommonCSP(where As %String = "docbook", verbose As %Boolean = 1) as %Status
Recopy our added common files. Where is the case-sensitive name of a subdirectory of /csp

For example where can be docbook or docbookj or documatic

classmethod CopyDocumaticCSP(verbose As %Boolean = 1) as %Status
Recopy our added files for the Documatic CSP directory
classmethod MakeDocBookCSPDir(verbose As %Boolean = 1)
classmethod RemoveAlgoliaCSP(where As %String = "docbook", verbose As %Boolean = 1) as %Status
classmethod RestoreOldZenJS(verbose As %Boolean = 1)

Inherited Members

Inherited Methods

FeedbackOpens in a new tab