Proposed Labels for OFBiz Technical Documentation

[Sharan-F]

Hi All

We will be adding labels to the documentation content to help make searching for documentation easier. At the moment we are proposing to use the following labels.

• Guide (to be used at the top level page for a specific guide)
• Tutorial (to be used at the top level page for a specific tutorial)
• Jboss
• System
• Administration (may need to combine with system)
• Security
• Deployment
• Development
• Geronimo
• Framework
• Data model (may need to combine this)
• Training
• Tomcat
• Localization
• Performance
• Websphere
• Glassfish

The labels seem to only support single words please let us know if you think that ‘sysadmin’ would be a better label than two separate ones e.g.  ‘system’ and ‘administration’

Please also let us have any feedback if there are any other specific labels that you think we should use.

Thanks
Sharan

[Adrian Crum-3]

Inline...

Adrian Crum
Sandglass Software
www.sandglass-software.com

On 8/29/2014 9:47 AM, Sharan-F wrote:
> Hi All
>
> We will be adding labels to the documentation content to help make searching
> for documentation easier. At the moment we are proposing to use the
> following labels.
>
> • Guide (to be used at the top level page for a specific guide)
> • Tutorial (to be used at the top level page for a specific tutorial)
> • Jboss

Jetty

> • System
> • Administration (may need to combine with system)
> • Security

Securing
Permisssions

> • Deployment
> • Development
> • Geronimo
> • Framework
> • Data model (may need to combine this)
> • Training
> • Tomcat
> • Localization

Internationalization
I18N

> • Performance
> • Websphere
> • Glassfish

JBoss, Glassfish, Tomcat, and Webshpere are all application servers - so
any page with those keywords should also include:

Application
Server
Container

>
> The labels seem to only support single words please let us know if you think
> that ‘sysadmin’ would be a better label than two separate ones e.g.
> ‘system’ and ‘administration’

Use both.

>
> Please also let us have any feedback if there are any other specific labels
> that you think we should use.
>
> Thanks
> Sharan
>
>
>
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
> Sent from the OFBiz - User mailing list archive at Nabble.com.
>

[Sharan-F]

Hi Adrian

Thanks for the feedback. I'll add your suggestions to our list.

Thanks
Sharan

[Jacques Le Roux]

Le 29/08/2014 10:47, Sharan-F a écrit :

> Hi All
>
> We will be adding labels to the documentation content to help make searching
> for documentation easier. At the moment we are proposing to use the
> following labels.
>
> • Guide (to be used at the top level page for a specific guide)
> • Tutorial (to be used at the top level page for a specific tutorial)
> • Jboss
> • System
> • Administration (may need to combine with system)
> • Security
> • Deployment
> • Development
> • Geronimo
> • Framework
> • Data model (may need to combine this)
> • Training
> • Tomcat
> • Localization
> • Performance
> • Websphere
> • Glassfish
>
> The labels seem to only support single words please let us know if you think
> that ‘sysadmin’ would be a better label than two separate ones e.g.
> ‘system’ and ‘administration’

I would put the 3 words ;)

Jacques

>
> Please also let us have any feedback if there are any other specific labels
> that you think we should use.
>
> Thanks
> Sharan
>
>
>
>
> --
> View this message in context: http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
> Sent from the OFBiz - User mailing list archive at Nabble.com.
>
>

[Ron Wheeler]

This list is not intended to stop people from adding labels that pertain
to a particular article but is an attempt to give people a set of search
topics that covers the common areas.
We hope that it will help eliminate confusion over terms like
localization and translation where there were 2 slightly different ideas
being used for the same concept on different pages.

The difficulty of adding synonyms is that the label system would require
that every system administration page be labeled with all three terms in
order for all pages to be returned for any one of the terms in a search.

Suggestion: Have a Terminology page for each synonym that just states
"If you are looking for system administration, please search using
"sysadmin". This page could be labeled with all of the system
administration terms that someone might use. A similar page for
"translation" might help people who don't think of "localization".

Ron

On 04/09/2014 4:26 AM, Jacques Le Roux wrote:

>
> Le 29/08/2014 10:47, Sharan-F a écrit :
>> Hi All
>>
>> We will be adding labels to the documentation content to help make
>> searching
>> for documentation easier. At the moment we are proposing to use the
>> following labels.
>>
>> •    Guide (to be used at the top level page for a specific guide)
>> •    Tutorial (to be used at the top level page for a specific tutorial)
>> •    Jboss
>> •    System
>> •    Administration (may need to combine with system)
>> •    Security
>> •    Deployment
>> •    Development
>> •    Geronimo
>> •    Framework
>> •    Data model (may need to combine this)
>> •    Training
>> •    Tomcat
>> •    Localization
>> •    Performance
>> •    Websphere
>> •    Glassfish
>>
>> The labels seem to only support single words please let us know if
>> you think
>> that ‘sysadmin’ would be a better label than two separate ones e.g.
>> ‘system’ and ‘administration’
>
> I would put the 3 words ;)
>
> Jacques
>
>>
>> Please also let us have any feedback if there are any other specific
>> labels
>> that you think we should use.
>>
>> Thanks
>> Sharan
>>
>>
>>
>>
>> --
>> View this message in context:
>> http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>
>>
>

--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: [phone], ext 102

[Jacques Le Roux]

Le 04/09/2014 16:11, Ron Wheeler a écrit :

> This list is not intended to stop people from adding labels that pertain to a particular article but is an attempt to give people a set of search
> topics that covers the common areas.
> We hope that it will help eliminate confusion over terms like localization and translation where there were 2 slightly different ideas being used
> for the same concept on different pages.
>
> The difficulty of adding synonyms is that the label system would require that every system administration page be labeled with all three terms in
> order for all pages to be returned for any one of the terms in a search.
>
> Suggestion: Have a Terminology page for each synonym that just states "If you are looking for system administration, please search using "sysadmin".
> This page could be labeled with all of the system administration terms that someone might use. A similar page for "translation" might help people
> who don't think of "localization".

That's quite a good idea Ron!

Jacques

>
> Ron
>
> On 04/09/2014 4:26 AM, Jacques Le Roux wrote:
>>
>> Le 29/08/2014 10:47, Sharan-F a écrit :
>>> Hi All
>>>
>>> We will be adding labels to the documentation content to help make searching
>>> for documentation easier. At the moment we are proposing to use the
>>> following labels.
>>>
>>> •    Guide (to be used at the top level page for a specific guide)
>>> •    Tutorial (to be used at the top level page for a specific tutorial)
>>> •    Jboss
>>> •    System
>>> •    Administration (may need to combine with system)
>>> •    Security
>>> •    Deployment
>>> •    Development
>>> •    Geronimo
>>> •    Framework
>>> •    Data model (may need to combine this)
>>> •    Training
>>> •    Tomcat
>>> •    Localization
>>> •    Performance
>>> •    Websphere
>>> •    Glassfish
>>>
>>> The labels seem to only support single words please let us know if you think
>>> that ‘sysadmin’ would be a better label than two separate ones e.g.
>>> ‘system’ and ‘administration’
>>
>> I would put the 3 words ;)
>>
>> Jacques
>>
>>>
>>> Please also let us have any feedback if there are any other specific labels
>>> that you think we should use.
>>>
>>> Thanks
>>> Sharan
>>>
>>>
>>>
>>>
>>> --
>>> View this message in context: http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>>
>>>
>>
>
>

[Adrian Crum-3]

One clarification here. Localization and translation are not 2 slightly
different ideas being used for the same concept.

Translation is one area of localization. Localization includes
translated text, number formatting, currency, date/time formatting, as
well as what calendar to use.

Adrian Crum
Sandglass Software
www.sandglass-software.com

On 9/4/2014 3:11 PM, Ron Wheeler wrote:

> This list is not intended to stop people from adding labels that pertain
> to a particular article but is an attempt to give people a set of search
> topics that covers the common areas.
> We hope that it will help eliminate confusion over terms like
> localization and translation where there were 2 slightly different ideas
> being used for the same concept on different pages.
>
> The difficulty of adding synonyms is that the label system would require
> that every system administration page be labeled with all three terms in
> order for all pages to be returned for any one of the terms in a search.
>
> Suggestion: Have a Terminology page for each synonym that just states
> "If you are looking for system administration, please search using
> "sysadmin". This page could be labeled with all of the system
> administration terms that someone might use. A similar page for
> "translation" might help people who don't think of "localization".
>
> Ron
>
> On 04/09/2014 4:26 AM, Jacques Le Roux wrote:
>>
>> Le 29/08/2014 10:47, Sharan-F a écrit :
>>> Hi All
>>>
>>> We will be adding labels to the documentation content to help make
>>> searching
>>> for documentation easier. At the moment we are proposing to use the
>>> following labels.
>>>
>>> •    Guide (to be used at the top level page for a specific guide)
>>> •    Tutorial (to be used at the top level page for a specific tutorial)
>>> •    Jboss
>>> •    System
>>> •    Administration (may need to combine with system)
>>> •    Security
>>> •    Deployment
>>> •    Development
>>> •    Geronimo
>>> •    Framework
>>> •    Data model (may need to combine this)
>>> •    Training
>>> •    Tomcat
>>> •    Localization
>>> •    Performance
>>> •    Websphere
>>> •    Glassfish
>>>
>>> The labels seem to only support single words please let us know if
>>> you think
>>> that ‘sysadmin’ would be a better label than two separate ones e.g.
>>> ‘system’ and ‘administration’
>>
>> I would put the 3 words ;)
>>
>> Jacques
>>
>>>
>>> Please also let us have any feedback if there are any other specific
>>> labels
>>> that you think we should use.
>>>
>>> Thanks
>>> Sharan
>>>
>>>
>>>
>>>
>>> --
>>> View this message in context:
>>> http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
>>>
>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>>
>>>
>>
>
>

[Ron Wheeler]

I think we are expressing the same difficulty of the use of
"translation" as a synonym for "localization".

However the problem remains that people who do not think of the
relationship between localization and translation may still search using
"translation" as the term when they are really looking for information
about "localization".

It would expect that a page about translation of text (list of services,
page about specific language issues, etc.) would be labeled with both
"translation" and "localization".
If someone searched for "translation", they would get the page about
"translation" as well as the page suggesting that "localization" would
be a useful alternative search if they did not get what they were
looking for using "translation" as a search term.


Ron

On 04/09/2014 2:56 PM, Adrian Crum wrote:

> One clarification here. Localization and translation are not 2
> slightly different ideas being used for the same concept.
>
> Translation is one area of localization. Localization includes
> translated text, number formatting, currency, date/time formatting, as
> well as what calendar to use.
>
> Adrian Crum
> Sandglass Software
> www.sandglass-software.com
>
> On 9/4/2014 3:11 PM, Ron Wheeler wrote:
>> This list is not intended to stop people from adding labels that pertain
>> to a particular article but is an attempt to give people a set of search
>> topics that covers the common areas.
>> We hope that it will help eliminate confusion over terms like
>> localization and translation where there were 2 slightly different ideas
>> being used for the same concept on different pages.
>>
>> The difficulty of adding synonyms is that the label system would require
>> that every system administration page be labeled with all three terms in
>> order for all pages to be returned for any one of the terms in a search.
>>
>> Suggestion: Have a Terminology page for each synonym that just states
>> "If you are looking for system administration, please search using
>> "sysadmin". This page could be labeled with all of the system
>> administration terms that someone might use. A similar page for
>> "translation" might help people who don't think of "localization".
>>
>> Ron
>>
>> On 04/09/2014 4:26 AM, Jacques Le Roux wrote:
>>>
>>> Le 29/08/2014 10:47, Sharan-F a écrit :
>>>> Hi All
>>>>
>>>> We will be adding labels to the documentation content to help make
>>>> searching
>>>> for documentation easier. At the moment we are proposing to use the
>>>> following labels.
>>>>
>>>> •    Guide (to be used at the top level page for a specific guide)
>>>> •    Tutorial (to be used at the top level page for a specific
>>>> tutorial)
>>>> •    Jboss
>>>> •    System
>>>> •    Administration (may need to combine with system)
>>>> •    Security
>>>> •    Deployment
>>>> •    Development
>>>> •    Geronimo
>>>> •    Framework
>>>> •    Data model (may need to combine this)
>>>> •    Training
>>>> •    Tomcat
>>>> •    Localization
>>>> •    Performance
>>>> •    Websphere
>>>> •    Glassfish
>>>>
>>>> The labels seem to only support single words please let us know if
>>>> you think
>>>> that ‘sysadmin’ would be a better label than two separate ones e.g.
>>>> ‘system’ and ‘administration’
>>>
>>> I would put the 3 words ;)
>>>
>>> Jacques
>>>
>>>>
>>>> Please also let us have any feedback if there are any other specific
>>>> labels
>>>> that you think we should use.
>>>>
>>>> Thanks
>>>> Sharan
>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> View this message in context:
>>>> http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html 
>>>>
>>>>
>>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>>>
>>>>
>>>
>>
>>
>

--
Ron Wheeler
President
Artifact Software Inc
email: [hidden email]
skype: ronaldmwheeler
phone: [phone], ext 102

[Jacques Le Roux]

And to complicate a bit more we have also internationalisation (i18n, when localisation is l10n)

Jacques

Le 04/09/2014 21:28, Ron Wheeler a écrit :

> I think we are expressing the same difficulty of the use of "translation" as a synonym for "localization".
>
> However the problem remains that people who do not think of the relationship between localization and translation may still search using
> "translation" as the term when they are really looking for information about "localization".
>
> It would expect that a page about translation of text (list of services, page about specific language issues, etc.) would be labeled with both
> "translation" and "localization".
> If someone searched for "translation", they would get the page about "translation" as well as the page suggesting that "localization" would be a
> useful alternative search if they did not get what they were looking for using "translation" as a search term.
>
>
> Ron
>
> On 04/09/2014 2:56 PM, Adrian Crum wrote:
>> One clarification here. Localization and translation are not 2 slightly different ideas being used for the same concept.
>>
>> Translation is one area of localization. Localization includes translated text, number formatting, currency, date/time formatting, as well as what
>> calendar to use.
>>
>> Adrian Crum
>> Sandglass Software
>> www.sandglass-software.com
>>
>> On 9/4/2014 3:11 PM, Ron Wheeler wrote:
>>> This list is not intended to stop people from adding labels that pertain
>>> to a particular article but is an attempt to give people a set of search
>>> topics that covers the common areas.
>>> We hope that it will help eliminate confusion over terms like
>>> localization and translation where there were 2 slightly different ideas
>>> being used for the same concept on different pages.
>>>
>>> The difficulty of adding synonyms is that the label system would require
>>> that every system administration page be labeled with all three terms in
>>> order for all pages to be returned for any one of the terms in a search.
>>>
>>> Suggestion: Have a Terminology page for each synonym that just states
>>> "If you are looking for system administration, please search using
>>> "sysadmin". This page could be labeled with all of the system
>>> administration terms that someone might use. A similar page for
>>> "translation" might help people who don't think of "localization".
>>>
>>> Ron
>>>
>>> On 04/09/2014 4:26 AM, Jacques Le Roux wrote:
>>>>
>>>> Le 29/08/2014 10:47, Sharan-F a écrit :
>>>>> Hi All
>>>>>
>>>>> We will be adding labels to the documentation content to help make
>>>>> searching
>>>>> for documentation easier. At the moment we are proposing to use the
>>>>> following labels.
>>>>>
>>>>> •    Guide (to be used at the top level page for a specific guide)
>>>>> •    Tutorial (to be used at the top level page for a specific tutorial)
>>>>> •    Jboss
>>>>> •    System
>>>>> •    Administration (may need to combine with system)
>>>>> •    Security
>>>>> •    Deployment
>>>>> •    Development
>>>>> •    Geronimo
>>>>> •    Framework
>>>>> •    Data model (may need to combine this)
>>>>> •    Training
>>>>> •    Tomcat
>>>>> •    Localization
>>>>> •    Performance
>>>>> •    Websphere
>>>>> •    Glassfish
>>>>>
>>>>> The labels seem to only support single words please let us know if
>>>>> you think
>>>>> that ‘sysadmin’ would be a better label than two separate ones e.g.
>>>>> ‘system’ and ‘administration’
>>>>
>>>> I would put the 3 words ;)
>>>>
>>>> Jacques
>>>>
>>>>>
>>>>> Please also let us have any feedback if there are any other specific
>>>>> labels
>>>>> that you think we should use.
>>>>>
>>>>> Thanks
>>>>> Sharan
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> --
>>>>> View this message in context:
>>>>> http://ofbiz.135035.n4.nabble.com/Proposed-Labels-for-OFBiz-Technical-Documentation-tp4654411.html
>>>>>
>>>>> Sent from the OFBiz - User mailing list archive at Nabble.com.
>>>>>
>>>>>
>>>>
>>>
>>>
>>
>
>