NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

To create and build a branded version copy the example nbia folder to a new folder. As an example, assume the copied folder is "ncia" and you plan to make a version named "NCIA".   Copy and name the folder and edit accordingly. Note the ncia_messages.properties contains much of the applications textual information and branding.properties contains the application names.   Once you have edited the files, edit the edit install.properties and the defaultAHP3.properties files in the /software/build directory. Specifically Specify the branding properties need to be specified, here is an . An example for naming an application "NCIA" follows.

Code Block
##############################################
### New Branding Properties ###
##############################################
branding.appname=NCIA
branding.folder=ncia

...

NamePurpose
logo.pngA logo (41 pixels high)
footer.htmlA snippet of HTML that is at the bottom. If included, %VERSION% will be replaced with the client version number (versionSuffix.txt, below), and %HOST_NAME% will be replaced with the server name.
newAccountUrl.txtURL for "New account" button on the login screen
accountHelpUrl.txtURL for "Account help" button on the login screen
downloaderUrl.txtURL for "Get Data Retriever" button in the Download popup
versionSuffix.txtAn optional string that will be appended to the version number, if the version number is included in the footer.
customMenu.jsonThis is the top horizontal menu. Look at the default (nbia) for an example.

...

NamePurpose
"entryTitle"The text of the top level menu item
"menuData""target" within "menuData" is the URL of the top-level menu item if you don't use a dropdown menu for this top-level item

"menuDataDropdown"

  • "menuText"
  • "target"

an array of dropdown menu items:

  • the text for the dropdown menu item
  • the URL for the dropdown menu item

Example of

...

Branded Properties

Code Block
[
    {
        "entryTitle": "Home",
        "menuData": {
            "target": "https://www.cancerimagingarchive.net"
        }
    },
    {
        "entryTitle": "News",
        "menuData": {
            "target": "https://www.cancerimagingarchive.net/news/"
        }
    },
    {
        "entryTitle": "About Us",
        "menuDataDropdown": [
            {
                "menuText": "About The Cancer Imaging Archive (TCIA)",
                "target": "https://www.cancerimagingarchive.net/about-the-cancer-imaging-archive-tcia"
            },
            {
                "menuText": "About the Cancer Imaging Program (CIP)",
                "target": "https://www.cancerimagingarchive.net/about-the-cancer-imaging-program-cip/"
            },
            {
                "menuText": "About the University of Arkansas for Medical Sciences (UAMS)",
                "target": "https://www.cancerimagingarchive.net/about-the-university-of-arkansas-for-medical-sciences-uams/"
            }
        ]
    },
...