Interface EditorVariablesConstants

  • All Known Implementing Classes:
    EditorVariables, EditorVariablesBase

    @API(type=NOT_EXTENDABLE,
         src=PRIVATE)
    public interface EditorVariablesConstants
    All the editor variables constants under one roof
    • Field Detail

      • EDITOR_VARIABLES_PREFIX

        static final java.lang.String EDITOR_VARIABLES_PREFIX
        The editor variables prefix.
        See Also:
        Constant Field Values
      • EDITOR_VARIABLES_SUFIX

        static final java.lang.String EDITOR_VARIABLES_SUFIX
        The editor variables sufix.
        See Also:
        Constant Field Values
      • FUNCTION_VARIABLE_SUFFIX

        static final java.lang.String FUNCTION_VARIABLE_SUFFIX
        Suffix for functions (env or system)
        See Also:
        Constant Field Values
      • SYSTEM_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String SYSTEM_FUNCTION_VARIABLE_PREFIX
        Prefix for system functions.
        See Also:
        Constant Field Values
      • ENV_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String ENV_FUNCTION_VARIABLE_PREFIX
        Prefix for environment functions.
        See Also:
        Constant Field Values
      • SYSTEM_VAR_NAME

        static final java.lang.String SYSTEM_VAR_NAME
        SYSTEM var name
        See Also:
        Constant Field Values
      • ENV_FUNCTION_SAMPLE

        static final java.lang.String ENV_FUNCTION_SAMPLE
        Sample of environment function specification
        See Also:
        Constant Field Values
      • SYSTEM_FUNCTION_SAMPLE

        static final java.lang.String SYSTEM_FUNCTION_SAMPLE
        Sample of system function specification
        See Also:
        Constant Field Values
      • DATE_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String DATE_FUNCTION_VARIABLE_PREFIX
        Prefix for date functions
        See Also:
        Constant Field Values
      • DATE_FUNCTION_SAMPLE

        static final java.lang.String DATE_FUNCTION_SAMPLE
        Sample of date function specification
        See Also:
        Constant Field Values
      • TIMESTAMP

        static final java.lang.String TIMESTAMP
        The time stamp. The value is ${timeStamp}.
        See Also:
        Constant Field Values
      • PATH_SEPARATOR

        static final java.lang.String PATH_SEPARATOR
        Path separator editor variable. Expands to ":" on Linux and Mac, ";" on Windows The value is ${ps}.
        See Also:
        Constant Field Values
      • USER_HOME_DIR

        static final java.lang.String USER_HOME_DIR
        The user home dir editor variable. The value is ${homeDir}.
        See Also:
        Constant Field Values
      • CT_CARET_EDITOR_VARIABLE

        static final java.lang.String CT_CARET_EDITOR_VARIABLE
        The caret editor variable.
        See Also:
        Constant Field Values
      • CT_SELECTION_EDITOR_VARIABLE

        static final java.lang.String CT_SELECTION_EDITOR_VARIABLE
        The caret editor variable.
        See Also:
        Constant Field Values
      • AUTHOR_NAME

        static final java.lang.String AUTHOR_NAME
        The editor variable pointing to the name of the current author set in the "Review" preferences page.
        See Also:
        Constant Field Values
      • CONFIGURED_DITA_OT_DIR

        static final java.lang.String CONFIGURED_DITA_OT_DIR
        The editor variable pointing to the user-configured DITA-OT directory.
        See Also:
        Constant Field Values
      • CONFIGURED_DITA_OT_DIR_URL

        static final java.lang.String CONFIGURED_DITA_OT_DIR_URL
        The editor variable pointing to the user-configured DITA-OT directory.
        See Also:
        Constant Field Values
      • CURRENT_FILE_DIRECTORY_URL

        static final java.lang.String CURRENT_FILE_DIRECTORY_URL
        The current file directory url editor variable. The value is ${cfdu}.
        See Also:
        Constant Field Values
      • CURRENT_FILE_DIRECTORY

        static final java.lang.String CURRENT_FILE_DIRECTORY
        The current file directory editor variable. The value is ${cfd}.
        See Also:
        Constant Field Values
      • CURRENT_FILE_URL

        static final java.lang.String CURRENT_FILE_URL
        The current file url editor variable. The value is ${currentFileURL}.
        See Also:
        Constant Field Values
      • CURRENT_FILE_URL_OLD

        static final java.lang.String CURRENT_FILE_URL_OLD
        The current file url editor variable old version. The value is ${cfu}.
        See Also:
        Constant Field Values
      • CURRENT_FILE

        static final java.lang.String CURRENT_FILE
        The current file editor variable. The value is ${cf}.
        See Also:
        Constant Field Values
      • CURRENT_FILENAME

        static final java.lang.String CURRENT_FILENAME
        The current filename editor variable. The value is ${cfn}.
        See Also:
        Constant Field Values
      • CURRENT_FILENAME_WITH_EXTENSION

        static final java.lang.String CURRENT_FILENAME_WITH_EXTENSION
        The current filename extension editor variable. The value is ${cfne}.
        See Also:
        Constant Field Values
      • PROJECT_DIRECTORY_URL

        static final java.lang.String PROJECT_DIRECTORY_URL
        The project directory URL editor variable. The value is ${pdu}.
        See Also:
        Constant Field Values
      • PROJECT_DIRECTORY

        static final java.lang.String PROJECT_DIRECTORY
        The project directory editor variable. The value is ${pd}.
        See Also:
        Constant Field Values
      • PROJECT_NAME

        static final java.lang.String PROJECT_NAME
        The project name editor variable The value is ${pn}.
        See Also:
        Constant Field Values
      • ARCHIVE_NAME

        static final java.lang.String ARCHIVE_NAME
        The archive name editor variable.
        See Also:
        Constant Field Values
      • ARCHIVE_NAME_WITH_EXTENSION

        static final java.lang.String ARCHIVE_NAME_WITH_EXTENSION
        The archive name with extension editor variable.
        See Also:
        Constant Field Values
      • ARCHIVE_PATH

        static final java.lang.String ARCHIVE_PATH
        The archive path editor variable.
        See Also:
        Constant Field Values
      • ARCHIVE_PATH_URL

        static final java.lang.String ARCHIVE_PATH_URL
        The archive path URL editor variable.
        See Also:
        Constant Field Values
      • ARCHIVE_FILE_DIRECTORY

        static final java.lang.String ARCHIVE_FILE_DIRECTORY
        The archive directory editor variable.
        See Also:
        Constant Field Values
      • ARCHIVE_FILE_DIRECTORY_URL

        static final java.lang.String ARCHIVE_FILE_DIRECTORY_URL
        The archive directory URL editor variable.
        See Also:
        Constant Field Values
      • FRAMEWORKS_DIRECTORY_URL

        static final java.lang.String FRAMEWORKS_DIRECTORY_URL
        The frameworks directory URL editor variable. The value is ${frameworks}.
        See Also:
        Constant Field Values
      • USER_HOME_URL

        static final java.lang.String USER_HOME_URL
        The user home URL editor variable. The value is ${home}.
        See Also:
        Constant Field Values
      • FRAMEWORKS_DIRECTORY

        static final java.lang.String FRAMEWORKS_DIRECTORY
        The frameworks directory editor variable. The value is ${frameworksDir}.
        See Also:
        Constant Field Values
      • FRAMEWORK_DIRECTORY

        static final java.lang.String FRAMEWORK_DIRECTORY
        Represents the framework directory where the document type that contains this reference resides. The value is ${frameworkDir}.
        See Also:
        Constant Field Values
      • FRAMEWORK_URL

        static final java.lang.String FRAMEWORK_URL
        The framework directory URL editor variable. The value is ${framework}.
        See Also:
        Constant Field Values
      • BASE_FRAMEWORK_DIRECTORY

        static final java.lang.String BASE_FRAMEWORK_DIRECTORY
        Represents the base framework directory where the extended document type that contains this reference resides. The value is ${baseFrameworkDir}.
        See Also:
        Constant Field Values
      • BASE_FRAMEWORK_URL

        static final java.lang.String BASE_FRAMEWORK_URL
        Represents the base framework URL where the extended document type that contains this reference resides. The value is ${baseFramework}.
        See Also:
        Constant Field Values
      • OXYGEN_INSTALL_DIR

        static final java.lang.String OXYGEN_INSTALL_DIR
        The oxygen install dir editor variable. The value is ${oxygenInstallDir}.
        See Also:
        Constant Field Values
      • DETECTED_SCHEMA

        static final java.lang.String DETECTED_SCHEMA
        The detected schema editor variable. The value is ${ds}.
        See Also:
        Constant Field Values
      • DETECTED_SCHEMA_URL

        static final java.lang.String DETECTED_SCHEMA_URL
        The detected schema URL editor variable. The value is ${dsu}.
        See Also:
        Constant Field Values
      • TRANSFORMATION_SAVED_FILE

        static final java.lang.String TRANSFORMATION_SAVED_FILE
        The transformation saved file editor Variable. The value is ${tsf}.
        See Also:
        Constant Field Values
      • DEBUGGER_XML_SOURCE

        static final java.lang.String DEBUGGER_XML_SOURCE
        The debugger XML input editor variable. The value is ${dbgXML}.
        See Also:
        Constant Field Values
      • DEBUGGER_XSL_SOURCE

        static final java.lang.String DEBUGGER_XSL_SOURCE
        The debugger XSL input editor variable. The value is ${dbgXSL}.
        See Also:
        Constant Field Values
      • FOP_TRANSFORMATION_METHOD

        static final java.lang.String FOP_TRANSFORMATION_METHOD
        The FOP transformation method editor variable. The value is ${method}.
        See Also:
        Constant Field Values
      • FOP_AH_TRANSFORMATION_METHOD

        static final java.lang.String FOP_AH_TRANSFORMATION_METHOD
        The FOP Antenna House transformation method editor variable. The value is ${ah_method}.
        See Also:
        Constant Field Values
      • FO_INPUT_FILE

        static final java.lang.String FO_INPUT_FILE
        The FO input file editor variable. The value is ${fo}.
        See Also:
        Constant Field Values
      • OUTPUT_FILE

        static final java.lang.String OUTPUT_FILE
        The output file editor variable. The value is ${out}.
        See Also:
        Constant Field Values
      • OUTPUT_FILE_URL

        static final java.lang.String OUTPUT_FILE_URL
        The output file URL editor variable. The value is ${outu}.
        See Also:
        Constant Field Values
      • OXYGEN_HOME_URL

        static final java.lang.String OXYGEN_HOME_URL
        The Oxygen Home URL editor variable. The value is ${oxygenHome}.
        See Also:
        Constant Field Values
      • XML

        static final java.lang.String XML
        XML Document editor variable. The value is ${xml}.
        See Also:
        Constant Field Values
      • XSL

        static final java.lang.String XSL
        XSL Document editor variable The value is ${xsl}.
        See Also:
        Constant Field Values
      • SQL

        static final java.lang.String SQL
        SQL Document editor variable The value is ${sql}.
        See Also:
        Constant Field Values
      • XQUERY

        static final java.lang.String XQUERY
        XQuery Document editor variable The value is ${xquery}.
        See Also:
        Constant Field Values
      • XPROC

        static final java.lang.String XPROC
        XProc Document editor variable The value is ${xproc}.
        See Also:
        Constant Field Values
      • XML_URL

        static final java.lang.String XML_URL
        XML Document URL editor variable The value is ${xmlu}.
        See Also:
        Constant Field Values
      • XSL_URL

        static final java.lang.String XSL_URL
        XSL Document URL editor variable The value is ${xslu}.
        See Also:
        Constant Field Values
      • SQL_URL

        static final java.lang.String SQL_URL
        XSL Document URL editor variable The value is ${xslu}.
        See Also:
        Constant Field Values
      • XQUERY_URL

        static final java.lang.String XQUERY_URL
        XSL Document URL editor variable The value is ${xslu}.
        See Also:
        Constant Field Values
      • XPROC_URL

        static final java.lang.String XPROC_URL
        XSL Document URL editor variable The value is ${xslu}.
        See Also:
        Constant Field Values
      • FIRST_FILE_TO_DIFF

        static final java.lang.String FIRST_FILE_TO_DIFF
        The first file to diff. The value is ${firstFile}.
        See Also:
        Constant Field Values
      • SECOND_FILE_TO_DIFF

        static final java.lang.String SECOND_FILE_TO_DIFF
        The second file to diff. The value is ${secondFile}.
        See Also:
        Constant Field Values
      • ANCESTOR_FILE_TO_DIFF

        static final java.lang.String ANCESTOR_FILE_TO_DIFF
        The ancestor file to diff. The value is ${ancestorFile}.
        See Also:
        Constant Field Values
      • UUID

        static final java.lang.String UUID
        The UUID. The value is ${uuid}.
        See Also:
        Constant Field Values
      • ID

        static final java.lang.String ID
        The unique friendly ID generated by Oxygen. The value is ${id}.
        See Also:
        Constant Field Values
      • ASK_PARAM_VALUE_TEMPLATE

        static final java.lang.String ASK_PARAM_VALUE_TEMPLATE
        Used to show the user the options he has to ask for a value.
        See Also:
        Constant Field Values
      • ASK_PARAM_START

        static final java.lang.String ASK_PARAM_START
        Start of ask variable.
        See Also:
        Constant Field Values
      • ANSWER_PARAM_START

        static final java.lang.String ANSWER_PARAM_START
        Start of answer variable.
        See Also:
        Constant Field Values
      • FRAMEWORK_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String FRAMEWORK_FUNCTION_VARIABLE_PREFIX
        Variable that identifies a framework URL location using its name.
        See Also:
        Constant Field Values
      • FRAMEWORK_URL_FUNCTION_TEMPLATE

        static final java.lang.String FRAMEWORK_URL_FUNCTION_TEMPLATE
        A template about how to use the function that expands to the URL of the framework with the given name,.
        See Also:
        Constant Field Values
      • FRAMEWORK_DIR_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String FRAMEWORK_DIR_FUNCTION_VARIABLE_PREFIX
        Variable that identifies a framework local directory using its name.
        See Also:
        Constant Field Values
      • FRAMEWORK_DIR_FUNCTION_TEMPLATE

        static final java.lang.String FRAMEWORK_DIR_FUNCTION_TEMPLATE
        A template about how to use the function that expands to the directory of the framework with the given name,.
        See Also:
        Constant Field Values
      • ROOT_MAP_URL

        static final java.lang.String ROOT_MAP_URL
        Editor variable which will be expanded to the current root map URL.
        See Also:
        Constant Field Values
      • ROOT_MAP_DIR

        static final java.lang.String ROOT_MAP_DIR
        Editor variable which will be expanded to the current root map parent directory file path.
        See Also:
        Constant Field Values
      • ROOT_MAP_DIR_URL

        static final java.lang.String ROOT_MAP_DIR_URL
        Editor variable which will be expanded to the current root map parent directory URL.
        See Also:
        Constant Field Values
      • ROOT_MAP_FILE

        static final java.lang.String ROOT_MAP_FILE
        Editor variable which will be expanded to the current root map file path.
        See Also:
        Constant Field Values
      • ACTIVE_PROFILING_CONDITION_SET

        static final java.lang.String ACTIVE_PROFILING_CONDITION_SET
        Editor variable which will be expanded to the profiling condition set name.
        See Also:
        Constant Field Values
      • XML_CATALOG_FILES_LIST

        static final java.lang.String XML_CATALOG_FILES_LIST
        A ";" delimited list of XML catalogs that Oxygen knows about.
        See Also:
        Constant Field Values
      • TRANSLATE_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String TRANSLATE_FUNCTION_VARIABLE_PREFIX
        Prefix for translate functions
        See Also:
        Constant Field Values
      • STATIC_XPATH_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String STATIC_XPATH_FUNCTION_VARIABLE_PREFIX
        Prefix for static xpath function editor variable.
        See Also:
        Constant Field Values
      • MAKE_RELATIVE_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String MAKE_RELATIVE_FUNCTION_VARIABLE_PREFIX
        Prefix for make relative editor variable.
        See Also:
        Constant Field Values
      • XPATH_FUNCTION_SAMPLE

        static final java.lang.String XPATH_FUNCTION_SAMPLE
        Sample of XPath function specification
        See Also:
        Constant Field Values
      • MAKE_RELATIVE_FUNCTION_SAMPLE

        static final java.lang.String MAKE_RELATIVE_FUNCTION_SAMPLE
        Sample of make relative Path function specification
        See Also:
        Constant Field Values
      • UNIQUE_CARET_MARKER_PI_NAME_FOR_AUTHOR

        static final java.lang.String UNIQUE_CARET_MARKER_PI_NAME_FOR_AUTHOR
        Unique marker used to position the caret
        See Also:
        Constant Field Values
      • UNIQUE_CARET_MARKER_FOR_AUTHOR

        static final java.lang.String UNIQUE_CARET_MARKER_FOR_AUTHOR
        Unique marker used to position the caret
        See Also:
        Constant Field Values
      • PLUGIN_DIR_URL_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String PLUGIN_DIR_URL_FUNCTION_VARIABLE_PREFIX
        Variable that identifies a plugin URL location using its name.
        See Also:
        Constant Field Values
      • PLUGIN_URL_FUNCTION_TEMPLATE

        static final java.lang.String PLUGIN_URL_FUNCTION_TEMPLATE
        A template about how to use the function that expands to the URL of the plugin with the given name,.
        See Also:
        Constant Field Values
      • PLUGIN_DIR_FUNCTION_VARIABLE_PREFIX

        static final java.lang.String PLUGIN_DIR_FUNCTION_VARIABLE_PREFIX
        Variable that identifies a plugin local directory using its name.
        See Also:
        Constant Field Values
      • PLUGIN_DIR_FUNCTION_TEMPLATE

        static final java.lang.String PLUGIN_DIR_FUNCTION_TEMPLATE
        A template about how to use the function that expands to the directory of the plugin with the given name,.
        See Also:
        Constant Field Values