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 Details

    • EDITOR_VARIABLES_PREFIX

      static final String EDITOR_VARIABLES_PREFIX
      The editor variables prefix.
      See Also:
    • EDITOR_VARIABLES_SUFIX

      static final String EDITOR_VARIABLES_SUFIX
      The editor variables sufix.
      See Also:
    • FUNCTION_VARIABLE_SUFFIX

      static final String FUNCTION_VARIABLE_SUFFIX
      Suffix for functions (env or system)
      See Also:
    • SYSTEM_FUNCTION_VARIABLE_PREFIX

      static final String SYSTEM_FUNCTION_VARIABLE_PREFIX
      Prefix for system functions.
      See Also:
    • ENV_FUNCTION_VARIABLE_PREFIX

      static final String ENV_FUNCTION_VARIABLE_PREFIX
      Prefix for environment functions.
      See Also:
    • ENV_VAR_NAME

      static final String ENV_VAR_NAME
      ENV var name
      See Also:
    • SYSTEM_VAR_NAME

      static final String SYSTEM_VAR_NAME
      SYSTEM var name
      See Also:
    • ENV_FUNCTION_SAMPLE

      static final String ENV_FUNCTION_SAMPLE
      Sample of environment function specification
      See Also:
    • SYSTEM_FUNCTION_SAMPLE

      static final String SYSTEM_FUNCTION_SAMPLE
      Sample of system function specification
      See Also:
    • DATE_FUNCTION_VARIABLE_PREFIX

      static final String DATE_FUNCTION_VARIABLE_PREFIX
      Prefix for date functions
      See Also:
    • DATE_FUNCTION_SAMPLE

      static final String DATE_FUNCTION_SAMPLE
      Sample of date function specification
      See Also:
    • TIMESTAMP

      static final String TIMESTAMP
      The time stamp. The value is ${timeStamp}.
      See Also:
    • PATH_SEPARATOR

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

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

      static final String CT_CARET_EDITOR_VARIABLE
      The caret editor variable.
      See Also:
    • CT_SELECTION_EDITOR_VARIABLE

      static final String CT_SELECTION_EDITOR_VARIABLE
      The caret editor variable.
      See Also:
    • AUTHOR_NAME

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

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

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

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

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

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

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

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

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

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

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

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

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

      static final String ARCHIVE_NAME
      The archive name editor variable.
      See Also:
    • ARCHIVE_NAME_WITH_EXTENSION

      static final String ARCHIVE_NAME_WITH_EXTENSION
      The archive name with extension editor variable.
      See Also:
    • ARCHIVE_PATH

      static final String ARCHIVE_PATH
      The archive path editor variable.
      See Also:
    • ARCHIVE_PATH_URL

      static final String ARCHIVE_PATH_URL
      The archive path URL editor variable.
      See Also:
    • ARCHIVE_FILE_DIRECTORY

      static final String ARCHIVE_FILE_DIRECTORY
      The archive directory editor variable.
      See Also:
    • ARCHIVE_FILE_DIRECTORY_URL

      static final String ARCHIVE_FILE_DIRECTORY_URL
      The archive directory URL editor variable.
      See Also:
    • FRAMEWORKS_DIRECTORY_URL

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

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

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

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

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

      static final 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:
    • BASE_FRAMEWORK_URL

      static final 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:
    • OXYGEN_INSTALL_DIR

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      static final String UUID
      The UUID. The value is ${uuid}.
      See Also:
    • ID

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

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

      static final String ASK_PARAM_START
      Start of ask variable.
      See Also:
    • ANSWER_PARAM_START

      static final String ANSWER_PARAM_START
      Start of answer variable.
      See Also:
    • FRAMEWORK_FUNCTION_VARIABLE_PREFIX

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

      static final 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:
    • FRAMEWORK_DIR_FUNCTION_VARIABLE_PREFIX

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

      static final 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:
    • ROOT_MAP_URL

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

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

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

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

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

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

      static final String TRANSLATE_FUNCTION_VARIABLE_PREFIX
      Prefix for translate functions
      See Also:
    • STATIC_XPATH_FUNCTION_VARIABLE_PREFIX

      static final String STATIC_XPATH_FUNCTION_VARIABLE_PREFIX
      Prefix for static xpath function editor variable.
      See Also:
    • MAKE_RELATIVE_FUNCTION_VARIABLE_PREFIX

      static final String MAKE_RELATIVE_FUNCTION_VARIABLE_PREFIX
      Prefix for make relative editor variable.
      See Also:
    • XPATH_FUNCTION_SAMPLE

      static final String XPATH_FUNCTION_SAMPLE
      Sample of XPath function specification
      See Also:
    • MAKE_RELATIVE_FUNCTION_SAMPLE

      static final String MAKE_RELATIVE_FUNCTION_SAMPLE
      Sample of make relative Path function specification
      See Also:
    • UNIQUE_CARET_MARKER_PI_NAME_FOR_AUTHOR

      static final String UNIQUE_CARET_MARKER_PI_NAME_FOR_AUTHOR
      Unique marker used to position the caret
      See Also:
    • UNIQUE_CARET_MARKER_FOR_AUTHOR

      static final String UNIQUE_CARET_MARKER_FOR_AUTHOR
      Unique marker used to position the caret
      See Also:
    • PLUGIN_DIR_URL_FUNCTION_VARIABLE_PREFIX

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

      static final 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:
    • PLUGIN_DIR_FUNCTION_VARIABLE_PREFIX

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

      static final 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: