d228124088
-added initial header to be consistent with other markdown pages -changed "...lower level..." to "...higher level..." -changed some italics to bold for consistency with other pages -added menu location description for the Localization Perspective -fixed "made" to "make" -changed some description text in "Customizing CAVE Menus" to make sense -added screenshot for that section -commented out the NCP section since it doesn't apply to our current version
100 lines
4.6 KiB
Markdown
100 lines
4.6 KiB
Markdown
# Localization perspective
|
||
## Localization Levels
|
||
|
||
AWIPS uses a hierarchical system known as *Localization* to configure many aspects of EDEX and CAVE, such as available menu items, color maps, and derived parameters. This system allows a user to override existing configurations and customize CAVE. For example, a _**User**-level_ localization file will supercede any similar file in a higher level (such as **Site**).
|
||
|
||
!!! note "There are three *levels of localization*, starting with the default **BASE**"
|
||
|
||
* **BASE** - default
|
||
* **SITE** - 3-letter WFO ID (required) overrides base
|
||
* **USER** - user-level localization overrides site and base
|
||
|
||
---
|
||
|
||
## Localization Editor
|
||
|
||
The Localization Perspective acts as file editor for the XML, Python, and text files which customize the look and feel of CAVE. This perspective is available in the menu **CAVE > Perspective > Localization**.
|
||
|
||
Users may copy and add files to available directories at their own **User** localization version.
|
||
|
||
Examples of things that can be accessed through the perspective include (this list is not all-inclusive):
|
||
|
||
* NCP Predefined Areas, Color Maps and Style Rules
|
||
|
||
* D2D Volume Browser Controls
|
||
|
||
* D2D Bundles - Scales (WFO, State(s), etc.)
|
||
|
||
* CAVE Map Overlays, Color Maps and Style Rules
|
||
|
||
* GFE Tools and Utilities
|
||
|
||
|
||
|
||
The left panel contains a directory heirarchy of CAVE files for D2D, GFE, and NCP, which can be copied and edited as *user* localization files.
|
||
|
||
|
||
|
||
There may be several versions of each file including **BASE**, **CONFIGURED** (GFE only), **SITE**, and **USER**. Each file version is listed separately under the actual file name.
|
||
|
||
The **_File Editor_** view opens the selected configuration file in an appropriate editor. For example, a Python file is opened in a Python editor, and an XML file is opened in an XML editor.
|
||
|
||
---
|
||
|
||
## Customizing CAVE Menus
|
||
|
||
Navigate to **D2D > Menus** and select a submenu (e.g. **satellite**). This directory lists all of the menu file contributions made by this data plugin. Most data menu directories will have an `index.xml` file from which you can investigate the menu structure and make needed changes.
|
||
|
||
Selecting a file such as `index.xml` (by double clicking, or expanding) will show a sub-menu with a default localization level (typically **BASE** or **CONFIGURED**). Double-click this file to open in the file editor (you may need to click **Source** at the bottom of the view to see the raw XML). Right-click this file and select **Copy To** > **User (_username_)** and you will see the file localization versions update with the new copy. Select this file to edit, and override, the existing version.
|
||
|
||
|
||
|
||
<!---
|
||
|
||
## Add new Predefined Area to NCP
|
||
|
||
In the Localization Perspective, navigate to ‘**NCEP - Predefined Area Menus**’, double-click ‘**AreaMenus.xml**’, and then right-click ‘**BASE**’ and select ‘**Copy To - User**’.
|
||
|
||
|
||
|
||
You will see a new ‘**USER (username)**’ entry for the file **AreaMenus.xml**.
|
||
|
||
|
||
|
||
Double-click the new file and copy or create a new AreaMenuItem entry, such as a new CONUS Mercator projection called **CONUS_Mercator**:
|
||
|
||
<AreaMenuItem subMenuName="" menuName="CONUS (Mercator)">
|
||
|
||
<source>PREDEFINED_AREA</source>
|
||
|
||
<areaName>CONUS_Mercator</areaName>
|
||
|
||
</AreaMenuItem>
|
||
|
||
|
||
|
||
Now you can either copy and paste an existing xml area file, or simple create one in the NCP. Switch back to the NCP, and select ‘**Area - World**’ to load a known Mercator projection. Zoom in to the continental United States and then from the menu bar select ‘**File - Save Area**’ and name it **CONUS_Mercator** so it matches the name string given in the above AreaMenuItem.
|
||
|
||
|
||
|
||
|
||
|
||
You can switch back to the Localization Perspective to confirm that the file was saved. It will be viewable under **NCEP - Predefined Areas** and, in this example, be called **CONUS_Mercator.xml**.
|
||
|
||
|
||
|
||
CAVE needs to be restarted in order for the new menu item to show up under the NCP **Area** menu.
|
||
|
||
|
||
|
||
Switch to the new Area to confirm.
|
||
|
||
|
||
|
||
On your workstation you can find the new USER localization files in ~/caveData
|
||
|
||
find ~/caveData -name CONUS_Mercator.xml
|
||
|
||
./etc/user/mjames/ncep/PredefinedAreas/CONUS_Mercator.xml
|
||
./.localization/NCEP/Predefined Areas/CONUS_Mercator.xml
|
||
-->
|