Difference between revisions of "Name the beast"
From Apache OpenOffice Wiki
(→Usages of the name) |
|||
(20 intermediate revisions by one other user not shown) | |||
Line 1: | Line 1: | ||
− | {{ | + | {{DraftPage|EN}} |
__TOC__ | __TOC__ | ||
Line 11: | Line 11: | ||
'State of the art' usage of the ''name'' - 2012-12-12: | 'State of the art' usage of the ''name'' - 2012-12-12: | ||
+ | ==== usage as ''name'' ==== | ||
{| class="wikitable" style="text-align: left; valign: top" | {| class="wikitable" style="text-align: left; valign: top" | ||
|- | |- | ||
Line 23: | Line 24: | ||
*fixed name of our Apache project | *fixed name of our Apache project | ||
*even fixed in derived products | *even fixed in derived products | ||
− | | | + | | orw: introduce certain resource/variable and use it instead of hard-coded strings |
| | | | ||
*About dialog: "... product based on Apache OpenOffice ..." | *About dialog: "... product based on Apache OpenOffice ..." | ||
Line 32: | Line 33: | ||
*in main/reportbuilder/license/readme_en-US.html|txt | *in main/reportbuilder/license/readme_en-US.html|txt | ||
| "Apache OpenOffice" - fixed until Apache OpenOffice project decides on a new name | | "Apache OpenOffice" - fixed until Apache OpenOffice project decides on a new name | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| PRODUCTNAME<sup>1</sup> | | PRODUCTNAME<sup>1</sup> | ||
Line 173: | Line 80: | ||
*in main/xmlsecurity/source/xmlsec/nss/nssinitializer.cxx | *in main/xmlsecurity/source/xmlsec/nss/nssinitializer.cxx | ||
| | | | ||
+ | |- | ||
+ | | in main/scp2/source/ooo/installation_ooo.scp | ||
+ | | two values: | ||
+ | *''SxwFormatName'' in combination with ''SxwFormatVersion'' for certain Windows registry entries of file associations of documents from "OpenOffice.org 1.1" applications | ||
+ | *''VendorName'': no clue of its usage | ||
+ | | | ||
+ | | | ||
+ | | "OpenOffice.org" | ||
|- | |- | ||
| hard-coded comparison to $PRODUCTNAME values<BR>in main/solenv/bin/modules/installer/download.pm | | hard-coded comparison to $PRODUCTNAME values<BR>in main/solenv/bin/modules/installer/download.pm | ||
Line 198: | Line 113: | ||
| | | | ||
| "OpenOffice.org" | | "OpenOffice.org" | ||
− | |||
|- | |- | ||
| manufacturer ? | | manufacturer ? | ||
Line 212: | Line 126: | ||
| | | | ||
| | | | ||
+ | |} | ||
+ | |||
+ | ==== usage as ''directory'' ==== | ||
+ | {| class="wikitable" style="text-align: left; valign: top" | ||
+ | |- | ||
+ | ! usage | ||
+ | ! description | ||
+ | ! comments | ||
+ | ! examples | ||
+ | ! value | ||
+ | |- | ||
+ | | BASISROOTNAME<sup>1</sup> | ||
+ | | 3-layer-office: folder name of the "basis layer" under Windows | ||
+ | | IMPORTANT: no longer used --> remove it | ||
| | | | ||
+ | | "OpenOffice.org" | ||
+ | |- | ||
+ | | UNIXBASISROOTNAME<sup>1</sup> | ||
+ | | 3-layer-office: folder name of the "basis layer" under Linux/Unix | ||
+ | | orw: Should be changed to lower case, no space containing variant of the Apache project name, e.g. "apacheopenoffice" | ||
+ | | | ||
+ | | "openoffice.org" | ||
+ | |- | ||
+ | | certain directory names | ||
+ | | | ||
+ | | current value correspond to BASISROOTNAME resp. UNIXBASISROOTNAME | ||
+ | | | ||
+ | *in main/scp2/source/ooo/ure_standalone.scp | ||
+ | *in main/setup_native/scripts/langpackscript.sh | ||
+ | *in main/setup_native/source/opensolaris/bundledextensions/svc-ooo_bundled_extensions | ||
+ | *in main/setup_native/source/packinfo/shellscripts_brand.txt | ||
+ | *in main/setup_native/source/packinfo/shellscripts_core01.txt | ||
+ | | | ||
+ | *"OpenOffice.org" on Windows | ||
+ | *"openoffice.org" on other platforms | ||
+ | |- | ||
+ | | hard-coded paths containing ''name'' | ||
+ | | ? | ||
+ | | seems to be paths for test installations | ||
+ | | | ||
+ | *in main/solenv/gbuild/platform/macosx.mk | ||
+ | *in main/solenv/gbuild/platform/os2.mk | ||
+ | *in main/solenv/gbuild/platform/windows.mk | ||
+ | *in main/solenv/inc/installationtest.mk | ||
+ | | | ||
+ | |- | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | ==== usage in installation artefacts ==== | ||
+ | {| class="wikitable" style="text-align: left; valign: top" | ||
+ | |- | ||
+ | ! usage | ||
+ | ! description | ||
+ | ! comments | ||
+ | ! examples | ||
+ | ! value | ||
+ | |- | ||
+ | | UREPACKAGEPREFIX<sup>1</sup> and SOLSUREPACKAGEPREFIX<sup>1</sup> | ||
+ | | name prefixes for the Linux resp. Solaris packages for the URE | ||
+ | | orw: document usage in new file [1] and change both to "apacheopenoffice" | ||
+ | | | ||
+ | | "openoffice.org" resp. "openofficeorg" | ||
|- | |- | ||
| keys and values in Windows registry | | keys and values in Windows registry | ||
Line 235: | Line 214: | ||
*in main/vcl/source/window/toolbox.cxx | *in main/vcl/source/window/toolbox.cxx | ||
| | | | ||
− | |- | + | |- |
− | | | + | | in module ODK |
| | | | ||
− | + | *part of Windows registry keys | |
+ | *part of 'hard-coded' directory paths | ||
+ | *part of 'hard-coded' names | ||
+ | | | ||
+ | | | ||
+ | *"HKEY_CURRENT_USER\\Software\\OpenOffice.org\\UNO\\InstallPath\\" | ||
+ | *"/Applications/OpenOffice.org.app" | ||
+ | *"OO_SDK_NAME=openoffice.org${OOVERSION}_sdk" | ||
+ | *"OFFICENAME=OpenOffice.org" | ||
+ | *"SDKDIRNAME=openoffice.org$(PRODUCT_RELEASE)_sdk" | ||
| | | | ||
− | |||
− | |||
− | |||
|- | |- | ||
− | |||
| | | | ||
− | | | + | | |
− | | | + | | |
− | | | + | | |
+ | |} | ||
+ | |||
+ | ==== misc usage - further investigation needed ==== | ||
+ | {| class="wikitable" style="text-align: left; valign: top" | ||
+ | |- | ||
+ | ! usage | ||
+ | ! description | ||
+ | ! comments | ||
+ | ! examples | ||
+ | ! value | ||
|- | |- | ||
| in module cli_ure | | in module cli_ure | ||
Line 286: | Line 280: | ||
*"Software\OpenOffice.org\Layers\[DEFINEDPRODUCT]\[BRANDPACKAGEVERSION]" | *"Software\OpenOffice.org\Layers\[DEFINEDPRODUCT]\[BRANDPACKAGEVERSION]" | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|- | |- | ||
| in module scripting | | in module scripting | ||
Line 345: | Line 306: | ||
| | | | ||
|- | |- | ||
− | | | + | | in module sysui |
− | | | + | | naming of build artifacts and Linux packages |
− | | | + | | |
+ | | | ||
| | | | ||
− | |||
− | |||
− | |||
− | |||
| | | | ||
|- | |- | ||
− | |||
− | |||
| | | | ||
| | | | ||
− | |||
| | | | ||
+ | | | ||
+ | |} | ||
+ | |||
+ | ==== uncritical usages - no (or minor) actions needed ==== | ||
+ | {| class="wikitable" style="text-align: left; valign: top" | ||
+ | |- | ||
+ | ! usage | ||
+ | ! description | ||
+ | ! comments | ||
+ | ! examples | ||
+ | ! value | ||
+ | |- | ||
+ | | SERVICE_PRODUCTNAME<sup>1</sup>, SERVICE_PARENTNAME<sup>1</sup>,<BR>REGISTRATION_HOST<sup>1</sup> and<BR>REGISTRATION_PRODUCT<sup>1</sup> | ||
+ | | registration data for 'OOo improvement via usage tracking'<BR>This is not active due to missing service. | ||
+ | | orw: document usage in new file [1] and change to Apache OpenOffice project name + its version number | ||
+ | | | ||
+ | | "OpenOffice.org 3.5"<BR>"https://registration.openoffice.org"<BR>"OpenOffice.org" | ||
+ | |- | ||
+ | | REGISTRATIONURL<sup>1</sup> | ||
+ | | seems not be used | ||
+ | | orw: remove it | ||
+ | | | ||
+ | | "http://survey.services.openoffice.org/user/index.php" | ||
+ | |- | ||
+ | | ODFNOTIFYURL<sup>1</sup> | ||
+ | | seems not be used.<BR>it exist code which expects that the value is found in the "version" file of an AOO installation. But on creation of the "version" file the value is not written to it. | ||
+ | | orw: remove it | ||
+ | | | ||
+ | | "http://odfnotify.services.openoffice.org/OOo3.0/notification.jsp?version=ODF" | ||
+ | |- | ||
+ | | FILEFORMATNAME<sup>1</sup> | ||
+ | | it denotes the ''OpenOffice.org XML file format''<sup>2</sup><BR>it is used in combination with FILEFORMATVERSION<sup>1</sup> which denotes the version of the ''OpenOffice.org XML file format'' | ||
+ | | orw: rename it to "OpenOffice.org XML" in order to distinguish it from the former project name | ||
+ | | | ||
+ | | "OpenOffice.org" | ||
+ | |- | ||
+ | | WRITERCOMPATIBILITYVERSIONOOO11<sup>1</sup> | ||
+ | | Name of OpenOffice.org version 1.1 for certain compatibility options in Writer | ||
+ | | orw: Leave it as it is | ||
+ | | | ||
+ | | "OpenOffice.org 1.1" | ||
+ | |- | ||
+ | | STARTCENTER_ADDFEATURE_URL<sup>1</sup> | ||
+ | | URL in start center to link to extension website | ||
+ | | orw: Leave it as it is | ||
+ | | | ||
+ | | "http://extensions.openoffice.org/" | ||
+ | |- | ||
+ | | STARTCENTER_INFO_URL<sup>1</sup> | ||
+ | | URL in start center to link to product homepage | ||
+ | | orw: Leave it as it is | ||
+ | | | ||
+ | | "http://www.openoffice.org" | ||
+ | |- | ||
+ | | STARTCENTER_TEMPLREP_URL<sup>1</sup> | ||
+ | | URL in start center to link to templates website | ||
+ | | orw: Leave it as it is | ||
+ | | | ||
+ | | "http://templates.openoffice.org" | ||
+ | |- | ||
+ | | DICT_REPO_URL<sup>1</sup> | ||
+ | | specifies a repository URL where users can download additional dictionaries<BR>via menu Tools - Language - More Dictionaries Online the URL is opened in the users default browser. "?lang=[locale from configuration]" - e.g. "?lang=en-US" - is added to the URL | ||
+ | | orw: leave it as it is | ||
+ | | | ||
+ | | "http://extensions.openoffice.org/dictionaries" | ||
+ | |- | ||
+ | | ExtensionUpdateURL | ||
+ | | URL which is used to obtain update information for extensions which do not provide an URL themselves. | ||
+ | | orw: leave it as it is | ||
+ | | in main/scp2/source/ooo/common_brand.scp | ||
+ | | "http://updateexte.services.openoffice.org/ExtensionUpdateService/check.Update" | ||
+ | |- | ||
+ | | UPDATEURL<sup>1</sup> | ||
+ | | URL for the application update functionality<BR>This URL is contacted via HTTP from the update functionality in order to figure out if a newer version of the application is available | ||
+ | | orw: change to "http://www.openoffice.org/projects/update/$SHORTAPACHEPROJECTNAME$APACHEPROJECTVERSION/check.Update, like the one for AOO34 branch | ||
+ | | | ||
+ | | | ||
+ | *"http://update38.services.openoffice.org/ProductUpdateService/check.Update" on trunk | ||
+ | *"http://www.openoffice.org/projects/update/aoo341/check.Update" on AOO34 branch | ||
+ | |- | ||
+ | | part of XML namespace declarations | ||
+ | | | ||
+ | | orw's opinion: should not be adapted | ||
+ | | | ||
+ | *xmlns="http://openoffice.org/2010/uno-components" | ||
+ | *xmlns:oor="http://openoffice.org/2001/registry" | ||
+ | | "openoffice.org" - fixed | ||
+ | |- | ||
+ | | part of Public Identifier of document type definitions (DTD) for internal used DTDs | ||
+ | | | ||
+ | | orw's opinion: should not be adapted, but ''name'' could be removed | ||
+ | | <!DOCTYPE statusbar:statusbar PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN" "statusbar.dtd"> | ||
+ | | "OpenOffice.org" | ||
+ | |- | ||
+ | | in module offapi | ||
+ | | part of documentation comments naming the project | ||
+ | | orw: not critical, but should be adapted to Apache project name | ||
+ | | | ||
+ | | "OpenOffice.org" | ||
|- | |- | ||
| | | |
Latest revision as of 10:24, 30 June 2018
Contents
Introduction
Purpose of this page is to document the work on Issue 121388 - Adapt naming "OpenOffice.org" --> "Apache OpenOffice".
Hopefully, it serves also the goal to have a guide how to "brand" your product based on the Apache OpenOffice project.
Usages of the name
'State of the art' usage of the name - 2012-12-12:
usage as name
usage | description | comments | examples | value |
---|---|---|---|---|
name of the Apache project |
|
orw: introduce certain resource/variable and use it instead of hard-coded strings |
|
"Apache OpenOffice" - fixed until Apache OpenOffice project decides on a new name |
PRODUCTNAME1 | name of the product | orw: change to "Apache OpenOffice" |
|
|
name of the product | orw: Should be adapted to $PRODUCTNAME resp. Apache project name |
|
||
in main/scp2/source/ooo/installation_ooo.scp | two values:
|
"OpenOffice.org" | ||
hard-coded comparison to $PRODUCTNAME values in main/solenv/bin/modules/installer/download.pm |
tweaking the product name part of the "download" installation package | orw: introduce new variable PRODUCTNAMEFORDOWNLOAD (e.g.) with corresponding values and adapt the corresponding code | ||
hard-coded comparison to $PRODUCTNAME values in main/solenv/bin/modules/installer/simplepackage.pm |
tweaking replacement of "SEARCHSCRIPTNAME" in certain script files. As "SEARCHSCRIPTNAME" is not found in any script file it does not seems to be needed any more. | orw: remove the code to replace "SEARCHSCRIPTNAME" in certain script files. | ||
hard-coded comparison to string containing "OpenOffice.org" (or variants) | ? | orw: still not sure about the impact. Help needed. |
|
|
application description | value in Windows registry key "HKEY_LOCAL_MACHINE\\Software\\OpenOffice.org\\...\\Capabilities\ApplicationDescription in main/scp2/source/ooo/registryitem_ooo.ulf |
orw: Should be adapted to something like "office productivity suite based on $[Apache OpenOffice project name] | "OpenOffice.org" | |
manufacturer ? | hard coded manufacturer "OpenOffice.org" | seem to be used in Windows registry deeper investigations needed |
|
|
usage as directory
usage | description | comments | examples | value |
---|---|---|---|---|
BASISROOTNAME1 | 3-layer-office: folder name of the "basis layer" under Windows | IMPORTANT: no longer used --> remove it | "OpenOffice.org" | |
UNIXBASISROOTNAME1 | 3-layer-office: folder name of the "basis layer" under Linux/Unix | orw: Should be changed to lower case, no space containing variant of the Apache project name, e.g. "apacheopenoffice" | "openoffice.org" | |
certain directory names | current value correspond to BASISROOTNAME resp. UNIXBASISROOTNAME |
|
| |
hard-coded paths containing name | ? | seems to be paths for test installations |
|
|
usage in installation artefacts
usage | description | comments | examples | value |
---|---|---|---|---|
UREPACKAGEPREFIX1 and SOLSUREPACKAGEPREFIX1 | name prefixes for the Linux resp. Solaris packages for the URE | orw: document usage in new file [1] and change both to "apacheopenoffice" | "openoffice.org" resp. "openofficeorg" | |
keys and values in Windows registry | orw's opinion: should be equal to product name |
|
||
in module ODK |
|
|
||
misc usage - further investigation needed
usage | description | comments | examples | value | |
---|---|---|---|---|---|
in module cli_ure | ? |
|
|||
in module desktop as part of a version info for Windows | ? | may be related to usage in module cli_ure |
|
||
in meta data about extensions | certain XML elements contain the name |
|
|||
as part of website URLs in the help content | orw: check the URLs, if still valid; adapt URLs | "openoffice.org" - fixed | |||
packaging process - *.idt files | ? |
|
|||
in module scripting | name as product name or name of the OpenOffice.org XML file format |
|
|||
in main/shell/source/win32/shlxthandler/prophdl/propertyhdl.cxx | ? | ||||
in module sysui | naming of build artifacts and Linux packages | ||||
uncritical usages - no (or minor) actions needed
usage | description | comments | examples | value |
---|---|---|---|---|
SERVICE_PRODUCTNAME1, SERVICE_PARENTNAME1, REGISTRATION_HOST1 and REGISTRATION_PRODUCT1 |
registration data for 'OOo improvement via usage tracking' This is not active due to missing service. |
orw: document usage in new file [1] and change to Apache OpenOffice project name + its version number | "OpenOffice.org 3.5" "https://registration.openoffice.org" "OpenOffice.org" | |
REGISTRATIONURL1 | seems not be used | orw: remove it | "http://survey.services.openoffice.org/user/index.php" | |
ODFNOTIFYURL1 | seems not be used. it exist code which expects that the value is found in the "version" file of an AOO installation. But on creation of the "version" file the value is not written to it. |
orw: remove it | "http://odfnotify.services.openoffice.org/OOo3.0/notification.jsp?version=ODF" | |
FILEFORMATNAME1 | it denotes the OpenOffice.org XML file format2 it is used in combination with FILEFORMATVERSION1 which denotes the version of the OpenOffice.org XML file format |
orw: rename it to "OpenOffice.org XML" in order to distinguish it from the former project name | "OpenOffice.org" | |
WRITERCOMPATIBILITYVERSIONOOO111 | Name of OpenOffice.org version 1.1 for certain compatibility options in Writer | orw: Leave it as it is | "OpenOffice.org 1.1" | |
STARTCENTER_ADDFEATURE_URL1 | URL in start center to link to extension website | orw: Leave it as it is | "http://extensions.openoffice.org/" | |
STARTCENTER_INFO_URL1 | URL in start center to link to product homepage | orw: Leave it as it is | "http://www.openoffice.org" | |
STARTCENTER_TEMPLREP_URL1 | URL in start center to link to templates website | orw: Leave it as it is | "http://templates.openoffice.org" | |
DICT_REPO_URL1 | specifies a repository URL where users can download additional dictionaries via menu Tools - Language - More Dictionaries Online the URL is opened in the users default browser. "?lang=[locale from configuration]" - e.g. "?lang=en-US" - is added to the URL |
orw: leave it as it is | "http://extensions.openoffice.org/dictionaries" | |
ExtensionUpdateURL | URL which is used to obtain update information for extensions which do not provide an URL themselves. | orw: leave it as it is | in main/scp2/source/ooo/common_brand.scp | "http://updateexte.services.openoffice.org/ExtensionUpdateService/check.Update" |
UPDATEURL1 | URL for the application update functionality This URL is contacted via HTTP from the update functionality in order to figure out if a newer version of the application is available |
orw: change to "http://www.openoffice.org/projects/update/$SHORTAPACHEPROJECTNAME$APACHEPROJECTVERSION/check.Update, like the one for AOO34 branch | ||
part of XML namespace declarations | orw's opinion: should not be adapted |
|
"openoffice.org" - fixed | |
part of Public Identifier of document type definitions (DTD) for internal used DTDs | orw's opinion: should not be adapted, but name could be removed | <!DOCTYPE statusbar:statusbar PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN" "statusbar.dtd"> | "OpenOffice.org" | |
in module offapi | part of documentation comments naming the project | orw: not critical, but should be adapted to Apache project name | "OpenOffice.org" | |
(1) variable found in /main/instsetoo_native/util/openoffice.lst
(2)http://www.openoffice.org/xml/xml_specification.pdf
[1] /main/instsetoo_native/util/openoffice.lst.README