Author: jleroux
Date: Sat Feb 28 16:29:24 2009
New Revision: 748884
URL: http://svn.apache.org/viewvc?rev=748884&view=rev
Log:
A patch from Bruno Busco "Linking End User Documentation to OFBiz"
(https://issues.apache.org/jira/browse/OFBIZ-2133) - OFBIZ-2133
Added:
ofbiz/trunk/applications/accounting/config/AccountingHelpUrls.xml
ofbiz/trunk/framework/common/config/CommonHelpUrls.xml
ofbiz/trunk/framework/common/webcommon/includes/helplink.ftl
Modified:
ofbiz/trunk/applications/accounting/widget/CommonScreens.xml
ofbiz/trunk/framework/common/webcommon/includes/header.ftl
ofbiz/trunk/framework/common/widget/CommonScreens.xml
ofbiz/trunk/themes/bluelight/includes/header.ftl
Added: ofbiz/trunk/applications/accounting/config/AccountingHelpUrls.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/config/AccountingHelpUrls.xml?rev=748884&view=auto
==============================================================================
--- ofbiz/trunk/applications/accounting/config/AccountingHelpUrls.xml (added)
+++ ofbiz/trunk/applications/accounting/config/AccountingHelpUrls.xml Sat Feb
28 16:29:24 2009
@@ -0,0 +1,142 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
+ <property key="ACCOUNTING_main">
+ <value xml:lang="en">01 Main</value>
+ </property>
+ <property key="ACCOUNTING_findInvoices">
+ <value xml:lang="en">02 Invoices</value>
+ </property>
+ <property key="ACCOUNTING_findPayments">
+ <value xml:lang="en">03 Payments</value>
+ </property>
+ <property key="ACCOUNTING_FindGatewayResponses">
+ <value xml:lang="en">04 Transactions</value>
+ </property>
+ <property key="ACCOUNTING_FindBillingAccount">
+ <value xml:lang="en">05 Billing Accounts</value>
+ </property>
+ <property key="ACCOUNTING_FindFinAccount">
+ <value xml:lang="en">06 Financial Accounts</value>
+ </property>
+ <property key="ACCOUNTING_EditFinAccount">
+ <value xml:lang="en">06.1 Financial Account</value>
+ </property>
+ <property key="ACCOUNTING_EditFinAccountRoles">
+ <value xml:lang="en">06.2 Roles</value>
+ </property>
+ <property key="ACCOUNTING_EditFinAccountTrans">
+ <value xml:lang="en">06.3 Transactions</value>
+ </property>
+ <property key="ACCOUNTING_EditFinAccountAuths">
+ <value xml:lang="en">06.4 Authorizations</value>
+ </property>
+ <property key="ACCOUNTING_FindTaxAuthority">
+ <value xml:lang="en">07 Tax Authorities</value>
+ </property>
+ <property key="ACCOUNTING_EditTaxAuthority">
+ <value xml:lang="en">07.1 Tax Authority</value>
+ </property>
+ <property key="ACCOUNTING_EditTaxAuthorityCategories">
+ <value xml:lang="en">07.2 Categories</value>
+ </property>
+ <property key="ACCOUNTING_EditTaxAuthorityAssocs">
+ <value xml:lang="en">07.3 Assocs</value>
+ </property>
+ <property key="ACCOUNTING_EditTaxAuthorityGlAccounts">
+ <value xml:lang="en">07.4 GL Accounts</value>
+ </property>
+ <property key="ACCOUNTING_EditTaxAuthorityRateProducts">
+ <value xml:lang="en">07.5 Product Rates</value>
+ </property>
+ <property key="ACCOUNTING_ListTaxAuthorityParties">
+ <value xml:lang="en">07.6 Parties</value>
+ </property>
+ <property key="ACCOUNTING_FindAgreement">
+ <value xml:lang="en">08 Agreements</value>
+ </property>
+ <property key="ACCOUNTING_ListFixedAssets">
+ <value xml:lang="en">09 Fixed Assets</value>
+ </property>
+ <property key="ACCOUNTING_FindGlobalGlAccount">
+ <value xml:lang="en">10 Global GL Settings</value>
+ </property>
+ <property key="ACCOUNTING_ListCompanies">
+ <value xml:lang="en">11 General Ledger</value>
+ </property>
+ <property key="ACCOUNTING_PartyAcctgPreference">
+ <value xml:lang="en">01 Accounting Preferences</value>
+ </property>
+ <property key="ACCOUNTING_ListGlAccountOrganization">
+ <value xml:lang="en">02 Chart of Accounts</value>
+ </property>
+ <property key="ACCOUNTING_SetupGlJournals">
+ <value xml:lang="en">03 Journals</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountTypeDefaults">
+ <value xml:lang="en">04 GL Account Defaults</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountTypeDefaults">
+ <value xml:lang="en">04.1 GL Account Type Defaults</value>
+ </property>
+ <property key="ACCOUNTING_EditProductGlAccounts">
+ <value xml:lang="en">04.2 Product GL Accounts</value>
+ </property>
+ <property key="ACCOUNTING_EditProductCategoryGlAccounts">
+ <value xml:lang="en">04.3 Product Category GL Account</value>
+ </property>
+ <property key="ACCOUNTING_EditFinAccountTypeGlAccounts">
+ <value xml:lang="en">04.4 FinAccount Type - GL Account</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountSalInvoice">
+ <value xml:lang="en">04.5 Sales Invoice</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountPurInvoice">
+ <value xml:lang="en">04.6 Purchase Invoice</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountTypePaymentType">
+ <value xml:lang="en">04.7 Payment Type - GL Account Type Id</value>
+ </property>
+ <property key="ACCOUNTING_GlAccountNrPaymentMethod">
+ <value xml:lang="en">04.8 Payment Method Id - Gl Account Id</value>
+ </property>
+ <property key="ACCOUNTING_EditVarianceReasonGlAccounts">
+ <value xml:lang="en">04.9 Variance Reason GL Accounts</value>
+ </property>
+ <property key="ACCOUNTING_EditCreditCardTypeGlAccounts">
+ <value xml:lang="en">04.10 Credit Card Type GL Account</value>
+ </property>
+ <property key="ACCOUNTING_EditOrganizationTaxAuthorityGlAccounts">
+ <value xml:lang="en">04.11 Tax Authority GL Accounts</value>
+ </property>
+ <property key="ACCOUNTING_EditPartyGlAccount">
+ <value xml:lang="en">04.12 Party GL Accounts</value>
+ </property>
+ <property key="ACCOUNTING_TimePeriods">
+ <value xml:lang="en">05 Time Period</value>
+ </property>
+ <property key="ACCOUNTING_ViewFXConversions">
+ <value xml:lang="en">06 Foreign Exchange Rates</value>
+ </property>
+ <property key="ACCOUNTING_PartyAccountsSummary">
+ <value xml:lang="en">11.2 Accounting</value>
+ </property>
+</resource>
Modified: ofbiz/trunk/applications/accounting/widget/CommonScreens.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/applications/accounting/widget/CommonScreens.xml?rev=748884&r1=748883&r2=748884&view=diff
==============================================================================
--- ofbiz/trunk/applications/accounting/widget/CommonScreens.xml (original)
+++ ofbiz/trunk/applications/accounting/widget/CommonScreens.xml Sat Feb 28
16:29:24 2009
@@ -30,6 +30,8 @@
<property-map resource="ManufacturingUiLabels"
map-name="uiLabelMap" global="true"/>
<property-map resource="CommonUiLabels" map-name="uiLabelMap"
global="true"/>
+ <property-map resource="AccountingHelpUrls"
map-name="helpUrlsMap" global="true"/>
+
<set field="layoutSettings.companyName"
from-field="uiLabelMap.AccountingCompanyName" global="true"/>
<set field="layoutSettings.companySubtitle"
from-field="uiLabelMap.AccountingCompanySubtitle" global="true"/>
<!-- layoutSettings.headerImageUrl can be used to specify an
application specific logo; if not set,
Added: ofbiz/trunk/framework/common/config/CommonHelpUrls.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/config/CommonHelpUrls.xml?rev=748884&view=auto
==============================================================================
--- ofbiz/trunk/framework/common/config/CommonHelpUrls.xml (added)
+++ ofbiz/trunk/framework/common/config/CommonHelpUrls.xml Sat Feb 28 16:29:24
2009
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<resource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";>
+ <property key="Prefix">
+ <value xml:lang="en">http://docs.ofbiz.org/display/OFBIZ/</value> <!--
Use this to link to the online OFBiz Confluence Documentation Space -->
+<!--
+ <value xml:lang="en">/help/OFBIZ-ENDUSER/OFBIZ/</value> Use this to
link to a locally exported Confluence Documentation Space
+-->
+ </property>
+ <property key="Suffix">
+ <value xml:lang="en"></value> <!-- Use this to link to the online
OFBiz Confluence Documentation Space -->
+<!--
+ <value xml:lang="en">.html</value> Use this to link to a locally
exported Confluence Documentation Space
+-->
+ </property>
+ <property key="HelpNotFound">
+ <value xml:lang="en">End User Documentation</value>
+ </property>
+</resource>
Modified: ofbiz/trunk/framework/common/webcommon/includes/header.ftl
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/webcommon/includes/header.ftl?rev=748884&r1=748883&r2=748884&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/webcommon/includes/header.ftl (original)
+++ ofbiz/trunk/framework/common/webcommon/includes/header.ftl Sat Feb 28
16:29:24 2009
@@ -158,6 +158,7 @@
<#if userLogin?exists>
<li><a
href="<@ofbizUrl>LookupVisualThemes</@ofbizUrl>">${uiLabelMap.CommonVisualThemes}</a></li>
</#if>
+ <#include "component://common/webcommon/includes/helplink.ftl" />
</ul>
</li>
</#if>
Added: ofbiz/trunk/framework/common/webcommon/includes/helplink.ftl
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/webcommon/includes/helplink.ftl?rev=748884&view=auto
==============================================================================
--- ofbiz/trunk/framework/common/webcommon/includes/helplink.ftl (added)
+++ ofbiz/trunk/framework/common/webcommon/includes/helplink.ftl Sat Feb 28
16:29:24 2009
@@ -0,0 +1,41 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";>
+<#--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+
+<#if webSiteId?exists && requestAttributes._CURRENT_VIEW_?exists>
+ <#assign helpTopic = webSiteId + "_" + requestAttributes._CURRENT_VIEW_ />
+ <#assign helpUrlTopic = helpUrlsMap["HelpNotFound"]/>
+ <#assign helpUrlPrefix = "" />
+ <#assign helpUrlSuffix = "" />
+
+<#-- uncomment this to show the current screen help topic key (this is usefull
to cut and paste in the help link resources files
+${helpTopic}
+-->
+
+ <#if helpUrlsMap["Prefix"] != "Prefix">
+ <#assign helpUrlPrefix = helpUrlsMap["Prefix"] />
+ </#if>
+ <#if helpUrlsMap["Suffix"] != "Suffix">
+ <#assign helpUrlSuffix = helpUrlsMap["Suffix"] />
+ </#if>
+ <#if helpUrlsMap[helpTopic] != helpTopic >
+ <#assign helpUrlTopic = helpUrlsMap[helpTopic] />
+ </#if>
+ <li><a href="${helpUrlPrefix}${helpUrlTopic}${helpUrlSuffix}"
target="_blank">${uiLabelMap.CommonHelp}</a></li>
+</#if>
Modified: ofbiz/trunk/framework/common/widget/CommonScreens.xml
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/framework/common/widget/CommonScreens.xml?rev=748884&r1=748883&r2=748884&view=diff
==============================================================================
--- ofbiz/trunk/framework/common/widget/CommonScreens.xml (original)
+++ ofbiz/trunk/framework/common/widget/CommonScreens.xml Sat Feb 28 16:29:24
2009
@@ -135,6 +135,8 @@
<set field="footerTemplateLocation"
from-field="layoutSettings.VT_FTR_TMPLT_LOC[0]"
default-value="component://common/webcommon/includes/footer.ftl"/>
<set field="appbarTemplateLocation"
from-field="layoutSettings.VT_NAV_TMPLT_LOC[0]"
default-value="component://common/webcommon/includes/appbar.ftl"/>
<set field="messagesTemplateLocation"
from-field="layoutSettings.VT_MSG_TMPLT_LOC[0]"
default-value="component://common/webcommon/includes/messages.ftl"/>
+
+ <property-map resource="CommonHelpUrls" map-name="helpUrlsMap"
global="true"/>
</actions>
<widgets>
<!-- render header -->
Modified: ofbiz/trunk/themes/bluelight/includes/header.ftl
URL:
http://svn.apache.org/viewvc/ofbiz/trunk/themes/bluelight/includes/header.ftl?rev=748884&r1=748883&r2=748884&view=diff
==============================================================================
--- ofbiz/trunk/themes/bluelight/includes/header.ftl (original)
+++ ofbiz/trunk/themes/bluelight/includes/header.ftl Sat Feb 28 16:29:24 2009
@@ -156,6 +156,7 @@
<#if userLogin?exists>
<li><a
href="<@ofbizUrl>LookupVisualThemes</@ofbizUrl>">${uiLabelMap.CommonVisualThemes}</a></li>
</#if>
+ <#include "component://common/webcommon/includes/helplink.ftl" />
</ul>
</li>
</#if>
