Difference between revisions of "Documentation/Administration Guide/Customizing the UI"

From Apache OpenOffice Wiki
Jump to: navigation, search
 
m
 
(25 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
<!-- {{DISPLAYTITLE: Customizing the User Interface}} -->
+
{{Documentation/AdminGuideTOC/v2
−
{{Documentation/AdminGuideTOC/v2}}
+
|ShowPrevNext=block
−
{{Documentation/Abstract|This chapter describes how to customize User Interface (UI) elements in {{OOo}}.}}
+
|ShowPrevPage=block
−
 
+
|ShowNextPage=block
 +
|PrevPage=Documentation/Administration Guide/Accessing Email Clients
 +
|NextPage=Documentation/Administration Guide/Restricting functionality
 +
}}
 +
{{DISPLAYTITLE: Customizing the User Interface}}
 +
__NOTOC__
 
==Creating a Customized XML Configuration File==
 
==Creating a Customized XML Configuration File==
  
−
{{OOo}} stores most of the UI configuration settings in Extensible Markup Language (XML) format. The UI components are defined in the XML-based User Interface Language (XUL) and stored in XML files.
+
{{AOo}} stores most of the User Interface (UI) configuration settings in Extensible Markup Language (XML) format. The UI components are defined in the XML-based User Interface Language (XUL) and stored in XML files.
  
−
{{OOo}} provides a '''Customize''' dialog box where you can make changes to most of the UI components. For example, you use this dialog box to add a custom menu to Writer.
+
{{AOo}} provides a '''Customize''' dialog box where you can make changes to most of the UI components. For example, you could use this dialog box to add a custom menu to Writer.
  
−
You can also edit an XML UI configuration file to make your changes. The XML elements and attributes for the {{OOo}} UI components are described [[#Using_a_Text_Editor|below]].
+
You can also edit an XML UI configuration file to make your changes. The XML elements and attributes for the {{AOo}} UI components are described [[#Using_a_Text_Editor|in the following sections]].
  
 
===Using the Customize Dialog Box===
 
===Using the Customize Dialog Box===
  
−
You can use the '''Customize''' dialog box to make changes to or to create the following UI components:
+
You can use the '''Customize''' dialog box to create or make changes to the following UI components:
  
 
* Menus
 
* Menus
−
* Shortcut Keys
+
* Shortcut keys
 
* Toolbars
 
* Toolbars
 
* Events
 
* Events
  
−
The changes are saved to an XML configuration file. After you make your changes in the '''Customize''' dialog box, you can use the XML configuration file that you created to apply the changes to other {{OOo}} installations.
+
The changes are saved to an XML configuration file. After you make your changes in the '''Customize''' dialog box, you can use the XML configuration file that you created to apply the changes to other {{AOo}} installations.
−
 
+
−
{{Documentation/Note|For more information on the location of the individual XML configuration files, see [[#Using_a_Text_Editor|below]]}}
+
  
 +
{{Note|For more information on the location of the individual XML configuration files, see [[#Using_a_Text_Editor|Using a Text Editor]]}}
  
 
====To Customize Menus, Keyboard Shortcuts, Toolbars, and Events====
 
====To Customize Menus, Keyboard Shortcuts, Toolbars, and Events====
−
[[Image:Documentation_AdminGuide_CustomizeDialogBox.png|right|thumb|250px|Customize Dialog box]]
+
# Open the {{AOo}} program where you want to customize a UI element.
−
# Open the {{OOo}} program where you want to customize a UI element.
+
# Choose {{menu|Tools|Customize}}<br>The '''Customize''' dialog box appears.  
−
# Choose '''Tools &rarr; Customize'''<br>The '''Customize''' dialog box opens.  
+
# Click the UI element tab you want to customize.
−
# Click the tab of the UI element that you want to customize.
+
# Make your changes and click {{button|OK}}.<br>The changes are saved to one or more XML configuration files in the {{AOo}} user directory. The file names and location for these files is <tt>''ooo-user-dir''/config/soffice.cfg/modules/''module-identifier''/''element-type''/''element-name''.xml</tt>
−
# Make your changes and then click '''OK'''.<br>The changes are saved to one or more XML configuration files in the {{OOo}} user directory. The file name path for these files is <tt>&lt;{{OOo}} user directory&gt;/config/soffice.cfg/modules/&lt;short module identifier&gt;/&lt;ui element type&gt;/&lt;ui element name&gt;.xml</tt>
+
:[[Image:Documentation_AdminGuide_CustomizeDialogBox.png|none|thumb|500px|Customize Dialog box]]
−
 
+
−
{{Documentation/Note|To look up the short module identifier for a {{OOo}} module, see the table below}}
+
  
−
===Using a Text Editor===
+
===Using a Text Editor for UI Customization===
  
−
You can also use a text editor to customize a UI element in an XML configuration file. For example, to remove a item from the '''Tools''' menu in Writer, you open the <tt>menubar.xml</tt> file for Writer, and delete the XML element for the menu item. If you want, you can also use XML configuration files to limit the functionality of {{OOo}}. See [[Documentation/Administration_Guide/Restricting_functionality|Restricting_functionality]] for more information.
+
You can also use a text editor to customize a UI element in an XML configuration file. For example, to remove an item from the {{menu|Tools}} menu in Writer, open the <tt>menubar.xml</tt> file for Writer, and delete the XML element for the menu item. You can also use XML configuration files to limit the functionality of {{AOo}}. See [[Documentation/Administration_Guide/Restricting_functionality|Restricting functionality]] for more information.
  
−
The UI configuration settings for each of the following components in a {{OOo}} module are stored in separate XML configuration files:
+
The UI configuration settings for each of the following components in an {{AOo}} module are stored in separate XML configuration files:
  
 
* Menu bars
 
* Menu bars
−
* Shortcut Keys
+
* Shortcut keys
 
* Toolbars
 
* Toolbars
 
* Events
 
* Events
Line 47: Line 49:
 
* Images
 
* Images
  
−
The file name path for the default XML configuration files for these UI elements <tt>&lt;{{OOo}} installation/share/config/soffice.cfg/modules/&lt;short module identifier&gt;/&lt;ui element type&gt;/&lt;ui element name&gt;.xml</tt>
+
These UI elements are located in <tt>''install-dir''/basics<version>/share/config/soffice.cfg/modules/''module-identifier''/''element-type''/''element-name''.xml</tt>
  
−
For example, the XML configuration file for the Writer menu bar is <tt>&lt;{{OOo}} installation&gt;/share/config/soffice.cfg/modules/swriter/menubar/menubar.xml</tt>
+
For example, the XML configuration file for the OpenOffice.org 3.2 Writer menu bar is <tt>''install-dir''/basics3.2/share/config/soffice.cfg/modules/swriter/menubar/menubar.xml</tt>
  
−
The short module indentifier for each {{OOo}} module is listed in the following table:
+
The following table lists the short module identifiers for each {{AOo}} module:
  
−
{|border=1 cellpadding=4 style="border-collapse:collapse;"
+
{|class="wikitable"
−
|+Short module identifiers for each {{OOo}} module.
+
|+Short Module Identifiers for {{AOo}} Modules
 
|-bgcolor=#EDEDED
 
|-bgcolor=#EDEDED
−
!{{OOo}} Module!!Short Module Identifier
+
!{{AOo}} Module!!Short Module Identifier
−
|-{{OOo}} Writer||swriter
+
|-{{AOo}} Writer||swriter
 
|-
 
|-
−
|{{OOo}} Writer/Web||sweb
+
|{{AOo}} Writer/Web||sweb
 
|-
 
|-
−
|{{OOo}} Writer/Globaldocument||sglobal
+
|{{AOo}} Writer/Globaldocument||sglobal
 
|-
 
|-
−
|{{OOo}} Calc||scalc
+
|{{AOo}} Calc||scalc
 
|-
 
|-
−
|{{OOo}} Draw||sdraw
+
|{{AOo}} Draw||sdraw
 
|-
 
|-
−
|{{OOo}} Impress||simpress
+
|{{AOo}} Impress||simpress
 
|-
 
|-
−
|{{OOo}} Math||smath
+
|{{AOo}} Math||smath
 
|-
 
|-
−
|{{OOo}} Chart||schart
+
|{{AOo}} Chart||schart
 
|-
 
|-
−
|{{OOo}} Bibliography||sbibliography
+
|{{AOo}} Bibliography||sbibliography
 
|-
 
|-
−
|{{OOo}} BasicIDE||BasicIDE
+
|{{AOo}} BasicIDE||BasicIDE
 
|-
 
|-
−
|{{OOo}} Database QueryDesign||dbquery
+
|{{AOo}} Database QueryDesign||dbquery
 
|-
 
|-
−
|{{OOo}} Database TableDesign||dbtable
+
|{{AOo}} Database TableDesign||dbtable
 
|-
 
|-
−
|{{OOo}} Database RelationDesign||dbrelation
+
|{{AOo}} Database RelationDesign||dbrelation
 
|-
 
|-
−
|{{OOo}} StartModule (Backing Component)||StartModule
+
|{{AOo}} StartModule (Backing Component)||StartModule
 
|}
 
|}
  
−
For a description of the XML elements and attributes that the {{OOo}} configuration files use, see the [http://xml.openoffice.org/xml_specification.pdf {{OOo}} XML File Format Technical Reference Manual]
+
For a description of the XML elements and attributes that the {{AOo}} configuration files use, see the [https://www.openoffice.org/xml/xml_specification.pdf {{AOo}} XML File Format Technical Reference Manual]
  
−
==Applying a Customized User Interface to Different {{OOo}} Installations==
+
==Applying a Customized User Interface to Different {{AOo}} Installations==
  
−
You can use XML configuration files to apply a customized user interface to one or more {{OOo}} installations.
+
You can use XML configuration files to apply a customized user interface to one or more {{AOo}} installations.
  
 
====To Apply a Customized User Interface to All Users on a Network====
 
====To Apply a Customized User Interface to All Users on a Network====
  
−
On a master {{OOo}} installation, create a customized XML configuration file for each UI element that you want to change, see
+
On a master {{AOo}} installation, create a customized XML configuration file for each UI element that you want to change. See
 
[[#Creating_a_Customized_XML_Configuration_File|Creating a Customized XML Configuration File]] for details.
 
[[#Creating_a_Customized_XML_Configuration_File|Creating a Customized XML Configuration File]] for details.
  
 
# Become root.
 
# Become root.
−
# Copy the contents of the <tt>&lt;{{OOo}} user directory&gt;/config/soffice.cfg/modules</tt> directory of the master installation to the <tt>&lt;{{OOo}} network installation directory&gt;/share/config/soffice.cfg/modules</tt> directory.
+
# Copy the contents of the <tt>''ooo-user-dir''/config/soffice.cfg/modules</tt> directory of the master installation to the <tt>''network-install-dir''/share/config/soffice.cfg/modules</tt> directory.
−
# Restart {{OOo}}.
+
# Restart {{AOo}}.
  
 
====To Apply a Customized User Interface to a Single User====
 
====To Apply a Customized User Interface to a Single User====
  
−
On a master {{OOo}} installation, create a customized XML configuration file for each UI element that you want to change, see [[#Creating_a_Customized_XML_Configuration_File|Creating a Customized XML Configuration File]] for details.
+
On a master {{AOo}} installation, create a customized XML configuration file for each UI element that you want to change. See [[#Creating_a_Customized_XML_Configuration_File|Creating a Customized XML Configuration File]] for details.
  
 
# Become root.
 
# Become root.
−
# Copy the contents of the <tt>&lt;{{OOo}} user directory&gt;/config/soffice.cfg/modules</tt> directory of the master installation to the <tt>&lt;{{OOo}} user directory&gt;/share/config/soffice.cfg/modules</tt> directory of the single user instalation.
+
# Copy the contents of the <tt>''ooo-user-dir''/config/soffice.cfg/modules</tt> directory of the master installation to the <tt>''ooo-user-dir''/share/config/soffice.cfg/modules</tt> directory of the single user installation.
−
# Restart {{OOo}}.
+
# Restart {{AOo}}.
  
 +
{{InterWiki Languages AdminGuide|articletitle=Documentation/Administration Guide/Customizing the UI}}
 
{{PDL1}}
 
{{PDL1}}

Latest revision as of 13:06, 15 February 2021


Creating a Customized XML Configuration File

Apache OpenOffice stores most of the User Interface (UI) configuration settings in Extensible Markup Language (XML) format. The UI components are defined in the XML-based User Interface Language (XUL) and stored in XML files.

Apache OpenOffice provides a Customize dialog box where you can make changes to most of the UI components. For example, you could use this dialog box to add a custom menu to Writer.

You can also edit an XML UI configuration file to make your changes. The XML elements and attributes for the Apache OpenOffice UI components are described in the following sections.

Using the Customize Dialog Box

You can use the Customize dialog box to create or make changes to the following UI components:

  • Menus
  • Shortcut keys
  • Toolbars
  • Events

The changes are saved to an XML configuration file. After you make your changes in the Customize dialog box, you can use the XML configuration file that you created to apply the changes to other Apache OpenOffice installations.

Documentation note.png For more information on the location of the individual XML configuration files, see Using a Text Editor

To Customize Menus, Keyboard Shortcuts, Toolbars, and Events

  1. Open the Apache OpenOffice program where you want to customize a UI element.
  2. Choose Tools → Customize
    The Customize dialog box appears.
  3. Click the UI element tab you want to customize.
  4. Make your changes and click  OK .
    The changes are saved to one or more XML configuration files in the Apache OpenOffice user directory. The file names and location for these files is ooo-user-dir/config/soffice.cfg/modules/module-identifier/element-type/element-name.xml
Customize Dialog box

Using a Text Editor for UI Customization

You can also use a text editor to customize a UI element in an XML configuration file. For example, to remove an item from the Tools menu in Writer, open the menubar.xml file for Writer, and delete the XML element for the menu item. You can also use XML configuration files to limit the functionality of Apache OpenOffice. See Restricting functionality for more information.

The UI configuration settings for each of the following components in an Apache OpenOffice module are stored in separate XML configuration files:

  • Menu bars
  • Shortcut keys
  • Toolbars
  • Events
  • Status bars
  • Images

These UI elements are located in install-dir/basics<version>/share/config/soffice.cfg/modules/module-identifier/element-type/element-name.xml

For example, the XML configuration file for the OpenOffice.org 3.2 Writer menu bar is install-dir/basics3.2/share/config/soffice.cfg/modules/swriter/menubar/menubar.xml

The following table lists the short module identifiers for each Apache OpenOffice module:

Short Module Identifiers for Apache OpenOffice Modules
Apache OpenOffice Module Short Module Identifier
Apache OpenOffice Writer/Web sweb
Apache OpenOffice Writer/Globaldocument sglobal
Apache OpenOffice Calc scalc
Apache OpenOffice Draw sdraw
Apache OpenOffice Impress simpress
Apache OpenOffice Math smath
Apache OpenOffice Chart schart
Apache OpenOffice Bibliography sbibliography
Apache OpenOffice BasicIDE BasicIDE
Apache OpenOffice Database QueryDesign dbquery
Apache OpenOffice Database TableDesign dbtable
Apache OpenOffice Database RelationDesign dbrelation
Apache OpenOffice StartModule (Backing Component) StartModule

For a description of the XML elements and attributes that the Apache OpenOffice configuration files use, see the Apache OpenOffice XML File Format Technical Reference Manual

Applying a Customized User Interface to Different Apache OpenOffice Installations

You can use XML configuration files to apply a customized user interface to one or more Apache OpenOffice installations.

To Apply a Customized User Interface to All Users on a Network

On a master Apache OpenOffice installation, create a customized XML configuration file for each UI element that you want to change. See Creating a Customized XML Configuration File for details.

  1. Become root.
  2. Copy the contents of the ooo-user-dir/config/soffice.cfg/modules directory of the master installation to the network-install-dir/share/config/soffice.cfg/modules directory.
  3. Restart Apache OpenOffice.

To Apply a Customized User Interface to a Single User

On a master Apache OpenOffice installation, create a customized XML configuration file for each UI element that you want to change. See Creating a Customized XML Configuration File for details.

  1. Become root.
  2. Copy the contents of the ooo-user-dir/config/soffice.cfg/modules directory of the master installation to the ooo-user-dir/share/config/soffice.cfg/modules directory of the single user installation.
  3. Restart Apache OpenOffice.
Content on this page is licensed under the Public Documentation License (PDL).
Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/Administration_Guide/Customizing_the_UI&oldid=247958"
Personal tools
In other languages