Re: Possible Documentation and help solutions - DITA

[Jacques Le Roux]

Le 16/06/2015 09:48, Jacques Le Roux a écrit :

FYI: I was not aware this existed http://asciidoctor.org/docs/asciidoctorj/
"Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of a 
parsed AsciiDoc document from Java and other JVM languages."

I see at least DocBook as backend option. We now from DocBook we can have more 
option with external tools, just saying, I have no clear ideas yet...

We Know...


Jacques

Le 15/06/2015 08:39, Sharan Foga a écrit :
Paul has raised a really key point - it's not only developers that we want to help document OFBiz. I like the idea of having something that is 
simple to use that gives a lot of flexibility and allows anyone to contribute.


We have the Community Day coming up on Saturday and I'm going to do some work on the online documentation. I will have a try at using Asciidoc for 
editing and then converting to Docbook. I can then give some feedback afterwards.


Thanks
Sharan

On 15/06/15 03:08, Paul Foxworthy wrote:

Hi all,


Ron Wheeler wrote

I expect that everyone has an IDE that can edit and validate XML. All
the other tools required are free.

...

OFBiz is pretty XML intensive so I would be surprised if OFBiz
developers did not use an IDE that can validate XML.

Do we only want developers to help documenting OFBIz? Expecting *any* IDE
and XML is already a barrier to a business expert who knows how to use OFBiz
but doesn't understand XML.


Ron Wheeler wrote

Yes but we do have multiple destinations to support - multiple
languages, multiple customizations, multiple brandings.
Topics are likely shared between the same on-line help topic - concepts
shared with different task descriptions.
Eliminate duplication of background material and ensure that there is
only one version of each concept description and that the up to date
description appears in each help screen.

Sharing of topics and multiple destinations are not unique to DITA.

Cheers

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670019.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Jacques Le Roux]

FYI: I was not aware this existed http://asciidoctor.org/docs/asciidoctorj/
"Using AsciidoctorJ, you can convert AsciiDoc content or analyze the structure of a 
parsed AsciiDoc document from Java and other JVM languages."

I see at least DocBook as backend option. We now from DocBook we can have more 
option with external tools, just saying, I have no clear ideas yet...

Jacques

Le 15/06/2015 08:39, Sharan Foga a écrit :
Paul has raised a really key point - it's not only developers that we want to help document OFBiz. I like the idea of having something that is 
simple to use that gives a lot of flexibility and allows anyone to contribute.


We have the Community Day coming up on Saturday and I'm going to do some work on the online documentation. I will have a try at using Asciidoc for 
editing and then converting to Docbook. I can then give some feedback afterwards.


Thanks
Sharan

On 15/06/15 03:08, Paul Foxworthy wrote:

Hi all,


Ron Wheeler wrote

I expect that everyone has an IDE that can edit and validate XML. All
the other tools required are free.

...

OFBiz is pretty XML intensive so I would be surprised if OFBiz
developers did not use an IDE that can validate XML.

Do we only want developers to help documenting OFBIz? Expecting *any* IDE
and XML is already a barrier to a business expert who knows how to use OFBiz
but doesn't understand XML.


Ron Wheeler wrote

Yes but we do have multiple destinations to support - multiple
languages, multiple customizations, multiple brandings.
Topics are likely shared between the same on-line help topic - concepts
shared with different task descriptions.
Eliminate duplication of background material and ensure that there is
only one version of each concept description and that the up to date
description appears in each help screen.

Sharing of topics and multiple destinations are not unique to DITA.

Cheers

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670019.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

On 14/06/2015 7:08 PM, Paul Foxworthy wrote:

Hi all,


Ron Wheeler wrote

I expect that everyone has an IDE that can edit and validate XML. All
the other tools required are free.

...

OFBiz is pretty XML intensive so I would be surprised if OFBiz
developers did not use an IDE that can validate XML.

Do we only want developers to help documenting OFBIz? Expecting *any* IDE
and XML is already a barrier to a business expert who knows how to use OFBiz
but doesn't understand XML.


The nice thing about DITA is that you can use whatever DITA authoring 
tool that you want (with a few exceptions) to produce DITA without 
impacting others ability to use their tool to edit the files that you 
altered.


The same is true about AsciiDoc but the other issues that I have 
mentioned previous make me a bit hesitant about AsciiDOC.


DocBook and DITA are very closely related and share many of the same 
benefits and issues.

DITA is a newer standard and is replacing DocBook in most organizations.




Ron Wheeler wrote

Yes but we do have multiple destinations to support - multiple
languages, multiple customizations, multiple brandings.
Topics are likely shared between the same on-line help topic - concepts
shared with different task descriptions.
Eliminate duplication of background material and ensure that there is
only one version of each concept description and that the up to date
description appears in each help screen.

Sharing of topics and multiple destinations are not unique to DITA.

Cheers

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670019.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.




--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Paul has raised a really key point - it's not only developers that we 
want to help document OFBiz. I like the idea of having something that is 
simple to use that gives a lot of flexibility and allows anyone to 
contribute.


We have the Community Day coming up on Saturday and I'm going to do some 
work on the online documentation. I will have a try at using Asciidoc 
for editing and then converting to Docbook. I can then give some 
feedback afterwards.


Thanks
Sharan

On 15/06/15 03:08, Paul Foxworthy wrote:

Hi all,


Ron Wheeler wrote

I expect that everyone has an IDE that can edit and validate XML. All
the other tools required are free.

...

OFBiz is pretty XML intensive so I would be surprised if OFBiz
developers did not use an IDE that can validate XML.

Do we only want developers to help documenting OFBIz? Expecting *any* IDE
and XML is already a barrier to a business expert who knows how to use OFBiz
but doesn't understand XML.


Ron Wheeler wrote

Yes but we do have multiple destinations to support - multiple
languages, multiple customizations, multiple brandings.
Topics are likely shared between the same on-line help topic - concepts
shared with different task descriptions.
Eliminate duplication of background material and ensure that there is
only one version of each concept description and that the up to date
description appears in each help screen.

Sharing of topics and multiple destinations are not unique to DITA.

Cheers

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670019.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Paul Foxworthy]

Hi all,


Ron Wheeler wrote
> I expect that everyone has an IDE that can edit and validate XML. All 
> the other tools required are free.
> 
> ...
> 
> OFBiz is pretty XML intensive so I would be surprised if OFBiz 
> developers did not use an IDE that can validate XML.

Do we only want developers to help documenting OFBIz? Expecting *any* IDE
and XML is already a barrier to a business expert who knows how to use OFBiz
but doesn't understand XML. 


Ron Wheeler wrote
> Yes but we do have multiple destinations to support - multiple 
> languages, multiple customizations, multiple brandings.
> Topics are likely shared between the same on-line help topic - concepts 
> shared with different task descriptions.
> Eliminate duplication of background material and ensure that there is 
> only one version of each concept description and that the up to date 
> description appears in each help screen.

Sharing of topics and multiple destinations are not unique to DITA.

Cheers

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670019.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Paul Foxworthy]

I said:

> When I last looked into DITA quite a few years ago, it seemed to be a 
> heavyweight thing that only made sense if you wanted multiple destinations 

Jacques said:

> So you think Docbook (more aimed to create book when DITA is more of
> online help 
> kind, I read) or AsciiDoc are not able to OOTB deliver in this way?

I don't think that at all. I have used AsciiDoc as a starting point to
create training material, and produced both print-ready PDF and HTML
complete with colour-coded code examples.

Fundamentally, if we have logical markup to start with, we can produce
whatever output we want. At that fundamental level, whether it's DocBook or
DITA is not important. What's important is logical markup, so everything has
a known purpose. If we know what any portion of the document is for, we can
make good decisions about what to do when we produce output.

I will be interested if anyone does create a DITA proof of concept. There is
a DocBook to DITA transformation XSLT stylesheet:
http://sourceforge.net/projects/dita-ot/files/Plug-in_%20dockbook2dita/docbook2dita%201.0/dbdita.zip/download,
so whoever is working on the POC could try it out to convert some of our
existing DocBook.

Cheers

Paul



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4670018.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

On 06/06/2015 5:20 PM, Jacques Le Roux wrote:

Thanks Taher,

Let's see...

Jacques

Le 06/06/2015 11:19, Taher Alkhateeb a écrit :

Hi Paul,

I am starting to use DITA and really like it. But I can see your 
point regarding people being put off. It might be in a sense a bit 
too powerful for OFBiz and it takes a while to wrap your head around 
the concepts like maps, topics, etc ... I'm on the fence, maybe 
leaning slightly towards keeping DocBook, but if a PoC shows how DITA 
can shine, then why not!

I agree that PoC is the next step.


Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org
Sent: Saturday, 6 June, 2015 9:10:28 AM
Subject: Re: Possible Documentation and help solutions - DITA

Sharan-F wrote

I'm a bit unclear about what you are suggesting.

* Is it about replacing the Docbook implementation we currently have
within OFBiz with something else (e.g Asciidoc)?
* Is it about extracting the Docbook content from what we currently
have in OFBiz and then generating it into another format that we
could possibly re-introduce?
* Or is it something else?

Hi Sharan,

My suggestion is much more modest than that. I think there's no need to
replace existing DocBook content, or to totally change the DocBook 
process

we have.

All I am suggesting is that people consider AsciiDoc as a first step 
when
authoring help information. If they prefer to work with DocBook 
directly,

fine. There are tools to transform AsciDoc into DocBook XML, such as
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written)
AsciiDoc *is* DocBook.

I'll repeat the reasons why I like AsciiDoc. It's more human-readable 
than
XML. You can write your documentation in any text editor. Both of 
these are
important. In contrast, requiring XML and some more specialised tool 
is a
barrier to entry, so less people could and would participate in 
documenting

OFBiz.

When I last looked into DITA quite a few years ago, it seemed to be a
heavyweight thing that only made sense if you wanted multiple 
destinations
and were willing to invest in proprietary tools like Framemaker, 
Oxygen or
Arbortext. I am perfectly willing to believe that DITA is more 
"complete"

than DocBook, and would allow "better" documentation, if only anyone was
willing to invest the time, trouble and money to be able to use it.

I'm pleased to hear there's now DITA support for Eclipse. Eclipse is 
not my
favourite IDE, but I could be persuaded to use it. How much better 
would it
be to say to potential contributors that they can use their favourite 
IDE or

text editor, whatever that is?

If everybody else loves DITA, I would work with it. But I worry that 
it will

put many people off.

Thanks

Paul Foxworthy



-





--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

On 06/06/2015 5:19 PM, Jacques Le Roux wrote:

Le 06/06/2015 08:10, Paul Foxworthy a écrit :

Sharan-F wrote

I'm a bit unclear about what you are suggesting.

   * Is it about replacing the Docbook implementation we currently have
 within OFBiz with something else (e.g Asciidoc)?
   * Is it about extracting the Docbook content from what we currently
 have in OFBiz and then generating it into another format that we
 could possibly re-introduce?
   * Or is it something else?

Hi Sharan,

My suggestion is much more modest than that. I think there's no need to
replace existing DocBook content, or to totally change the DocBook 
process

we have.

All I am suggesting is that people consider AsciiDoc as a first step 
when
authoring help information. If they prefer to work with DocBook 
directly,

fine. There are tools to transform AsciDoc into DocBook XML, such as
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written)
AsciiDoc *is* DocBook.

I'll repeat the reasons why I like AsciiDoc. It's more human-readable 
than
XML. You can write your documentation in any text editor. Both of 
these are
important. In contrast, requiring XML and some more specialised tool 
is a
barrier to entry, so less people could and would participate in 
documenting

OFBiz.


That's exactly the point indeed, thanks to stress that Paul.
I expect that everyone has an IDE that can edit and validate XML. All 
the other tools required are free.





When I last looked into DITA quite a few years ago, it seemed to be a
heavyweight thing that only made sense if you wanted multiple 
destinations


This seems to answer to my question just asked to Ron on the user ML. 
So you think Docbook (more aimed to create book when DITA is more of 
online help kind, I read) or AsciiDoc are not able to OOTB deliver in 
this way?
Yes but we do have multiple destinations to support - multiple 
languages, multiple customizations, multiple brandings.
Topics are likely shared between the same on-line help topic - concepts 
shared with different task descriptions.
Eliminate duplication of background material and ensure that there is 
only one version of each concept description and that the up to date 
description appears in each help screen.


and were willing to invest in proprietary tools like Framemaker, 
Oxygen or
Arbortext. I am perfectly willing to believe that DITA is more 
"complete"

than DocBook, and would allow "better" documentation, if only anyone was
willing to invest the time, trouble and money to be able to use it.

I would not advise purchasing anything unless you are strictly working 
as a technical documentation writter and do not have an IDE and do not 
understand XML.
I'm pleased to hear there's now DITA support for Eclipse. Eclipse is 
not my
favourite IDE, but I could be persuaded to use it. How much better 
would it
be to say to potential contributors that they can use their favourite 
IDE or

text editor, whatever that is?


I am sure that other IDE's support XML and auto-completion of XML.
What IDE's are important?
OFBiz is pretty XML intensive so I would be surprised if OFBiz 
developers did not use an IDE that can validate XML.


http://when-others-then-null.blogspot.co.uk/2012/12/Validate-XML-against-an-XSD-using-npp.html 
talks about using Notepad++ as a validating editor.


If everybody else loves DITA, I would work with it. But I worry that it 
will

put many people off.
Possibly but then again OFBiz would be built with Visual Basic if 
popularity was the main criteria:-)


That's the point we need to clarify...

Jacques



Thanks

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669576.html

Sent from the OFBiz - Dev mailing list archive at Nabble.com.






--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Re: Possible Documentation and help solutions - DITA

[Jacques Le Roux]

Thanks Taher,

Let's see...

Jacques

Le 06/06/2015 11:19, Taher Alkhateeb a écrit :

Hi Paul,

I am starting to use DITA and really like it. But I can see your point 
regarding people being put off. It might be in a sense a bit too powerful for 
OFBiz and it takes a while to wrap your head around the concepts like maps, 
topics, etc ... I'm on the fence, maybe leaning slightly towards keeping 
DocBook, but if a PoC shows how DITA can shine, then why not!

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org
Sent: Saturday, 6 June, 2015 9:10:28 AM
Subject: Re: Possible Documentation and help solutions - DITA

Sharan-F wrote

I'm a bit unclear about what you are suggesting.

* Is it about replacing the Docbook implementation we currently have
within OFBiz with something else (e.g Asciidoc)?
* Is it about extracting the Docbook content from what we currently
have in OFBiz and then generating it into another format that we
could possibly re-introduce?
* Or is it something else?

Hi Sharan,

My suggestion is much more modest than that. I think there's no need to
replace existing DocBook content, or to totally change the DocBook process
we have.

All I am suggesting is that people consider AsciiDoc as a first step when
authoring help information. If they prefer to work with DocBook directly,
fine. There are tools to transform AsciDoc into DocBook XML, such as
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written)
AsciiDoc *is* DocBook.

I'll repeat the reasons why I like AsciiDoc. It's more human-readable than
XML. You can write your documentation in any text editor. Both of these are
important. In contrast, requiring XML and some more specialised tool is a
barrier to entry, so less people could and would participate in documenting
OFBiz.

When I last looked into DITA quite a few years ago, it seemed to be a
heavyweight thing that only made sense if you wanted multiple destinations
and were willing to invest in proprietary tools like Framemaker, Oxygen or
Arbortext. I am perfectly willing to believe that DITA is more "complete"
than DocBook, and would allow "better" documentation, if only anyone was
willing to invest the time, trouble and money to be able to use it.

I'm pleased to hear there's now DITA support for Eclipse. Eclipse is not my
favourite IDE, but I could be persuaded to use it. How much better would it
be to say to potential contributors that they can use their favourite IDE or
text editor, whatever that is?

If everybody else loves DITA, I would work with it. But I worry that it will
put many people off.

Thanks

Paul Foxworthy



-

Re: Possible Documentation and help solutions - DITA

[Jacques Le Roux]

Le 06/06/2015 08:10, Paul Foxworthy a écrit :

Sharan-F wrote

I'm a bit unclear about what you are suggesting.

   * Is it about replacing the Docbook implementation we currently have
 within OFBiz with something else (e.g Asciidoc)?
   * Is it about extracting the Docbook content from what we currently
 have in OFBiz and then generating it into another format that we
 could possibly re-introduce?
   * Or is it something else?

Hi Sharan,

My suggestion is much more modest than that. I think there's no need to
replace existing DocBook content, or to totally change the DocBook process
we have.

All I am suggesting is that people consider AsciiDoc as a first step when
authoring help information. If they prefer to work with DocBook directly,
fine. There are tools to transform AsciDoc into DocBook XML, such as
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written)
AsciiDoc *is* DocBook.

I'll repeat the reasons why I like AsciiDoc. It's more human-readable than
XML. You can write your documentation in any text editor. Both of these are
important. In contrast, requiring XML and some more specialised tool is a
barrier to entry, so less people could and would participate in documenting
OFBiz.


That's exactly the point indeed, thanks to stress that Paul.


When I last looked into DITA quite a few years ago, it seemed to be a
heavyweight thing that only made sense if you wanted multiple destinations


This seems to answer to my question just asked to Ron on the user ML. So you think Docbook (more aimed to create book when DITA is more of online help 
kind, I read) or AsciiDoc are not able to OOTB deliver in this way?



and were willing to invest in proprietary tools like Framemaker, Oxygen or
Arbortext. I am perfectly willing to believe that DITA is more "complete"
than DocBook, and would allow "better" documentation, if only anyone was
willing to invest the time, trouble and money to be able to use it.

I'm pleased to hear there's now DITA support for Eclipse. Eclipse is not my
favourite IDE, but I could be persuaded to use it. How much better would it
be to say to potential contributors that they can use their favourite IDE or
text editor, whatever that is?

If everybody else loves DITA, I would work with it. But I worry that it will
put many people off.


That's the point we need to clarify...

Jacques



Thanks

Paul Foxworthy



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669576.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Paul, 

I am starting to use DITA and really like it. But I can see your point 
regarding people being put off. It might be in a sense a bit too powerful for 
OFBiz and it takes a while to wrap your head around the concepts like maps, 
topics, etc ... I'm on the fence, maybe leaning slightly towards keeping 
DocBook, but if a PoC shows how DITA can shine, then why not! 

Taher Alkhateeb 

- Original Message -

From: "Paul Foxworthy"  
To: dev@ofbiz.apache.org 
Sent: Saturday, 6 June, 2015 9:10:28 AM 
Subject: Re: Possible Documentation and help solutions - DITA 

Sharan-F wrote 
> I'm a bit unclear about what you are suggesting. 
> 
> * Is it about replacing the Docbook implementation we currently have 
> within OFBiz with something else (e.g Asciidoc)? 
> * Is it about extracting the Docbook content from what we currently 
> have in OFBiz and then generating it into another format that we 
> could possibly re-introduce? 
> * Or is it something else? 

Hi Sharan, 

My suggestion is much more modest than that. I think there's no need to 
replace existing DocBook content, or to totally change the DocBook process 
we have. 

All I am suggesting is that people consider AsciiDoc as a first step when 
authoring help information. If they prefer to work with DocBook directly, 
fine. There are tools to transform AsciDoc into DocBook XML, such as 
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written) 
AsciiDoc *is* DocBook. 

I'll repeat the reasons why I like AsciiDoc. It's more human-readable than 
XML. You can write your documentation in any text editor. Both of these are 
important. In contrast, requiring XML and some more specialised tool is a 
barrier to entry, so less people could and would participate in documenting 
OFBiz. 

When I last looked into DITA quite a few years ago, it seemed to be a 
heavyweight thing that only made sense if you wanted multiple destinations 
and were willing to invest in proprietary tools like Framemaker, Oxygen or 
Arbortext. I am perfectly willing to believe that DITA is more "complete" 
than DocBook, and would allow "better" documentation, if only anyone was 
willing to invest the time, trouble and money to be able to use it. 

I'm pleased to hear there's now DITA support for Eclipse. Eclipse is not my 
favourite IDE, but I could be persuaded to use it. How much better would it 
be to say to potential contributors that they can use their favourite IDE or 
text editor, whatever that is? 

If everybody else loves DITA, I would work with it. But I worry that it will 
put many people off. 

Thanks 

Paul Foxworthy 



- 
-- 
Coherent Software Australia Pty Ltd 
http://www.coherentsoftware.com.au/ 

Bonsai ERP, the all-inclusive ERP system 
http://www.bonsaierp.com.au/ 

-- 
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669576.html
 
Sent from the OFBiz - Dev mailing list archive at Nabble.com. 

Re: Possible Documentation and help solutions - DITA

[Paul Foxworthy]

Sharan-F wrote
> Confluence is the Apache approved tools for wiki so we still need to work
> within this constraint for now. In any case – I think we firstly need to
> do some review of the all the documentation we have before we start
> structuring it.

Hi Sharan,

There is a free tool to import DocBook into Confluence :
https://marketplace.atlassian.com/plugins/org.jboss.labs.confluence.plugin.docbook_import

There's also a commercial one to go in the other direction:
https://www.k15t.com/software/scroll-docbook-exporter/overview . *If* we
wanted to use the wiki as a place to develop help, we could ask the vendor
if they were willing to donate their product to an open source project.

Cheers

Paul Foxworthy




-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669577.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Paul Foxworthy]

Sharan-F wrote
> I'm a bit unclear about what you are suggesting.
> 
>   * Is it about replacing the Docbook implementation we currently have
> within OFBiz with something else (e.g Asciidoc)?
>   * Is it about extracting the Docbook content from what we currently
> have in OFBiz and then generating it into another format that we
> could possibly re-introduce?
>   * Or is it something else?

Hi Sharan,

My suggestion is much more modest than that. I think there's no need to
replace existing DocBook content, or to totally change the DocBook process
we have.

All I am suggesting is that people consider AsciiDoc as a first step when
authoring help information. If they prefer to work with DocBook directly,
fine. There are tools to transform AsciDoc into DocBook XML, such as
AsciiDoctor (http://asciidoctor.org/), so in effect (correctly written)
AsciiDoc *is* DocBook.

I'll repeat the reasons why I like AsciiDoc. It's more human-readable than
XML. You can write your documentation in any text editor. Both of these are
important. In contrast, requiring XML and some more specialised tool is a
barrier to entry, so less people could and would participate in documenting
OFBiz.

When I last looked into DITA quite a few years ago, it seemed to be a
heavyweight thing that only made sense if you wanted multiple destinations
and were willing to invest in proprietary tools like Framemaker, Oxygen or
Arbortext. I am perfectly willing to believe that DITA is more "complete"
than DocBook, and would allow "better" documentation, if only anyone was
willing to invest the time, trouble and money to be able to use it.

I'm pleased to hear there's now DITA support for Eclipse. Eclipse is not my
favourite IDE, but I could be persuaded to use it. How much better would it
be to say to potential contributors that they can use their favourite IDE or
text editor, whatever that is?

If everybody else loves DITA, I would work with it. But I worry that it will
put many people off.

Thanks

Paul Foxworthy 



-
--
Coherent Software Australia Pty Ltd
http://www.coherentsoftware.com.au/

Bonsai ERP, the all-inclusive ERP system
http://www.bonsaierp.com.au/

--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669576.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Sharan-F]

Hi Taher

Thanks for the response. 

I think that working through your action list would be a really good move so
am happy to work on it.

I think we'll need to take this discussion off the mailing list as it is
because we will need to share files (such as the ones that dont work etc) so
I will create a Jira to manage it. (The Jira updates will be posted back
here anyway!)

Thanks
Sharan





--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669487.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Sharan, 

Well thought and makes sense. In a way our problem is in the process rather 
than the technology. And small steps are one of humanity's best concepts IMHO. 

So may I suggest a set of actions to move forward: 
- First, we attempt to fix whatever is wrong in DocBook at the moment. If you 
can share exactly what you spotted then this would save us a lot of time in 
trying to dig to the problem. So a repeat process to identify the bugs from you 
would be great. 
- Second, we decide on a category structure for the sections of the 
documentation if we do not like the existing one 
- We also introduce or enforce a workflow that mandates an update of the 
documentation on each JIRA that affects functionality that requires 
documentation. For example, if we add or modify a screen in the party 
component, then we must provide the documentation for that screen before 
closing the JIRA for example. 
- As a last step we decide on the appropriate technology to move forward. 

Now, in the philosophy of small steps and being a guy who likes to jump into 
action, I suggest we start with the first point above and move from there. 
Thoughts? 

Taher Alkhateeb 

- Original Message -

From: "Sharan-F"  
To: dev@ofbiz.apache.org 
Sent: Thursday, 4 June, 2015 11:01:58 AM 
Subject: Re: Possible Documentation and help solutions - DITA 

Hi Taher 

It would be good to understand what exactly is missing from our Docbook 
implementation. It might be that we have set the tags at a specific level 
(e.g section etc) which means that we cant use chapters etc. 

I'm still thinking but the main thing that concerns me is this. 

There is a lot of focus about changing the technology but no focus on how we 
integrate it or manage it. It's not only about changing the technology - we 
need to address the underlying problems. 

Why is our online documentation not being kept up to date? These are the 
main reasons I think are: 

- it is too hard to keep up to date as each change needs to be submitted as 
a patch 
- you need to understand and create the new data items for the CMS for each 
page of documentation - existing items need to be linked into the correct 
place in the document hierarchy 
- the docbook implementation isn't complete and there are a lot standard 
tags that cannot be used 

One the End User documentation side remember that Confluence is the Apache 
approved tools for wiki so we still need to work within this constraint for 
now. In any case – I think we firstly need to do some review of the all the 
documentation we have before we start structuring it. 

If changing to another format (DITA, Asciidoc etc) within OFBiz itself is 
going to generate a lot of work on the framework etc – why don't we try some 
small steps first just to see what we can do. It will also show if we can 
really start adding some value. 

Paul mentioned that Asciidoc could be a good compromise as it converts to 
Docbook and other formats. 

What about doing a small proof of concept (PoC) just to see what editing 
using Asciidoc could be like? 

The scope would be not to replace Docbook in OFBiz but just to see how we 
can use and edit in Asciidoc and how it can generate Docbook or other 
formats. 

- Could we extract the existing OFBiz online help and put it into Asciidoc 
format 
- Put the Online help Asciidoc somewhere where it can be edited and updated 
- Extract updated Asciidoc back into Docbook (or other) format 
- See if it can be re-introduced back into OFBiz (e.g. directly as a patch 
or as part as an ant target) 

Does this seem reasonable? If so are there any volunteers who'd like to work 
with me on this PoC? 

Thanks 
Sharan 




-- 
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669411.html
 
Sent from the OFBiz - Dev mailing list archive at Nabble.com. 

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

I am willing to work on a DITA PoC.

Ron

On 04/06/2015 4:01 AM, Sharan-F wrote:

Hi Taher

It would be good to understand what exactly is missing from our Docbook
implementation. It might  be that we have set the tags at a specific level
(e.g section etc) which means that we cant use  chapters etc.

I'm still thinking but the main thing that concerns me is this.

There is a lot of focus about changing the technology but no focus on how we
integrate it or manage it. It's not only about changing the technology - we
need to address the underlying problems.

Why is our online documentation not being kept up to date?  These are the
main reasons I think are:

- it is too hard to keep up to date as each change needs to be submitted as
a patch
- you need to understand and create the new data items for the CMS for each
page of documentation - existing items need to be linked into the correct
place in the document hierarchy
- the docbook implementation isn't complete and there are a lot standard
tags that cannot be used

One the End User documentation side remember that Confluence is the Apache
approved tools for wiki so we still need to work within this constraint for
now. In any case – I think we firstly need to do some review of the all the
documentation we have before we start structuring it.

If changing to another format (DITA, Asciidoc etc) within OFBiz itself is
going to generate a lot of work on the framework etc – why don't we try some
small steps first just to see what we can do. It will also show if we can
really start adding some value.

Paul mentioned that Asciidoc could be a good compromise as it converts to
Docbook and other formats.

What about doing a small proof of concept (PoC) just to see what editing
using Asciidoc could be like?

The scope would be not to replace Docbook in OFBiz but just to see how we
can use and edit in Asciidoc and how it can generate Docbook or other
formats.

- Could we extract the existing OFBiz online help and put it into Asciidoc
format
- Put the Online help Asciidoc somewhere where it can be edited and updated
- Extract updated Asciidoc back into Docbook (or other) format
- See if it can be re-introduced back into OFBiz (e.g. directly as a patch
or as part as an ant target)

Does this seem reasonable? If so are there any volunteers who'd like to work
with me on this PoC?

Thanks
Sharan




--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669411.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.




--
Ron Wheeler
President
Artifact Software Inc
email: rwhee...@artifact-software.com
skype: ronaldmwheeler
phone: 866-970-2435, ext 102

Re: Possible Documentation and help solutions - DITA

[Sharan-F]

Hi Taher

It would be good to understand what exactly is missing from our Docbook
implementation. It might  be that we have set the tags at a specific level
(e.g section etc) which means that we cant use  chapters etc.

I'm still thinking but the main thing that concerns me is this.

There is a lot of focus about changing the technology but no focus on how we
integrate it or manage it. It's not only about changing the technology - we
need to address the underlying problems. 

Why is our online documentation not being kept up to date?  These are the
main reasons I think are:

- it is too hard to keep up to date as each change needs to be submitted as
a patch 
- you need to understand and create the new data items for the CMS for each
page of documentation - existing items need to be linked into the correct
place in the document hierarchy 
- the docbook implementation isn't complete and there are a lot standard
tags that cannot be used

One the End User documentation side remember that Confluence is the Apache
approved tools for wiki so we still need to work within this constraint for
now. In any case – I think we firstly need to do some review of the all the
documentation we have before we start structuring it.

If changing to another format (DITA, Asciidoc etc) within OFBiz itself is
going to generate a lot of work on the framework etc – why don't we try some
small steps first just to see what we can do. It will also show if we can
really start adding some value.

Paul mentioned that Asciidoc could be a good compromise as it converts to
Docbook and other formats. 

What about doing a small proof of concept (PoC) just to see what editing
using Asciidoc could be like?

The scope would be not to replace Docbook in OFBiz but just to see how we
can use and edit in Asciidoc and how it can generate Docbook or other
formats.

- Could we extract the existing OFBiz online help and put it into Asciidoc
format
- Put the Online help Asciidoc somewhere where it can be edited and updated
- Extract updated Asciidoc back into Docbook (or other) format
- See if it can be re-introduced back into OFBiz (e.g. directly as a patch
or as part as an ant target)

Does this seem reasonable? If so are there any volunteers who'd like to work
with me on this PoC?

Thanks
Sharan




--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669411.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

On 03/06/2015 5:09 AM, Sharan Foga wrote:

Hi Paul

I've got some other threads open on the user mailing lists about 
documentation strategies because I wanted to get some feedback from 
the user community and I'm a bit unclear about what you are suggesting.


 * Is it about replacing the Docbook implementation we currently have
   within OFBiz with something else (e.g Asciidoc)?

Yes

 * Is it about extracting the Docbook content from what we currently
   have in OFBiz and then generating it into another format that we
   could possibly re-introduce?

Yes


 * Or is it something else?
Yes. building a library of topics that can be used to assemble user 
documentation, create marketing materials, creating proposals, creating 
contracts, etc





Thanks
Sharan


On 03/06/15 10:47, Paul Foxworthy wrote:

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's 
not

limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. 
To me

this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  
wrote:


Anne Rockley is one of the top DITA experts and her webinars are 
excellent.

If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a webinar 
that

relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her 
concerns also
apply to regulated industries or business functions that are 
regulated such

as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 


sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>" 


blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279> 







<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 





*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing 
Content

in Life Sciences and Healthcare Survey <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1RuOIAV_DUctsI2wCR4toOjyKztJhEoLjdTD4Y1Ren2vX3ZehMrhjBScQO1s5npvjaGD4gMUa2M=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA== 


Localizing Regulated Content While Saving Time and Money <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVBVnHwvucfHT2zNvF1yPKz-NSvdYGJIul-7dtewqWjcn18DV-CMGgiz67VaaXrAnbGxcEphlVOUfA7iyRqmz3MJOvS60jTD9VX9GWA0F4hmIg-gVS8NhsxfPiZWO0IKTzMzMr2h12horjIiz66wAcvRqjmkzh3Wj4g==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA== 


Bridging Pharma Content Silos: Managing Content from Clinical Through
Labeling and Marketing 

I

Re: Possible Documentation and help solutions - DITA

[Ron Wheeler]

There are free tools - Eclipse/STS if you do not already have an IDE.
The publishing tool DITA-OT is open source.

There are tools that can be purchased.
I have not purchased anything.


On 03/06/2015 4:47 AM, Paul Foxworthy wrote:

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me
this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  wrote:


Anne Rockley is one of the top DITA experts and her webinars are excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her concerns also
apply to regulated industries or business functions that are regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"
blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279>





<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>



*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing Content
in Life Sciences and Healthcare Survey <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1RuOIAV_DUctsI2wCR4toOjyKztJhEoLjdTD4Y1Ren2vX3ZehMrhjBScQO1s5npvjaGD4gMUa2M=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
Localizing Regulated Content While Saving Time and Money <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVBVnHwvucfHT2zNvF1yPKz-NSvdYGJIul-7dtewqWjcn18DV-CMGgiz67VaaXrAnbGxcEphlVOUfA7iyRqmz3MJOvS60jTD9VX9GWA0F4hmIg-gVS8NhsxfPiZWO0IKTzMzMr2h12horjIiz66wAcvRqjmkzh3Wj4g==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
Bridging Pharma Content Silos: Managing Content from Clinical Through
Labeling and Marketing 

Intelligently Managing the Complexities of the Core Data Sheet <
https://www.brighttalk.com/webcast/9273/146091>


*Upcoming Events and Presentations*

*LocWorld 28 - Localization World 2015 in Berlin, Germany*

03 June - Join Ann Rockley and others for the Life Sciences Business
Roundtable <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNKkQku0rPdubcmGs9xZj-nU756cGD8h9GUq0niuPwDarZHhfLSyhyXG-TwKft5pJ4gYmRgftjttrmcQ_Pdb-g1syVUc4058f35z53DcsvP_-BV25Cw1yUYd2db4QnPe1d0JsoaDXGKTxnkedl-GtzB6zLwWhkZWerXTd1OF3vk8PXHCuojL_CRQ==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Sharan, 

Ok great so we can confirm the problem is related to docbook implementation in 
OFBiz. Now on a quick glance the resources for docbook exist in: 
- component://cmssite/template/docbook 
- component://content/dtd/docbook.* 
- a few CSS files in the themes 

I think this is fixable but there are a few places to investigate and I can 
probably help if you show me how to reproduce the error on my computer . 
However, I am not sure now whether we should try to fix this if we are 
considering changing the documentation technology. What do you think? 

Taher Alkhateeb 

- Original Message -

From: "Sharan-F"  
To: dev@ofbiz.apache.org 
Sent: Wednesday, 3 June, 2015 3:32:02 PM 
Subject: Re: Possible Documentation and help solutions - DITA 

Hi Taher 

I've just had a go with the validating the HR Guide file. When I ran the 
validation the only message I got was that it stripped the namespace before 
processing. 

The output file was fine (I didnt include the path to the images so they are 
coming out as blank frames) but everything else displays OK and all the 
links within the document work. 

Thanks 
Sharan 



-- 
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669395.html
 
Sent from the OFBiz - Dev mailing list archive at Nabble.com. 

Re: Possible Documentation and help solutions - DITA

[Sharan-F]

Hi Taher

I've just had a go with the validating the HR Guide file. When I ran the
validation the only message I got was that it stripped the namespace before
processing.

The output file was fine (I didnt include the path to the images so they are
coming out as blank frames) but everything else displays OK and all the
links within the document work.

Thanks
Sharan



--
View this message in context: 
http://ofbiz.135035.n4.nabble.com/Possible-Documentation-and-help-solutions-DITA-tp4669377p4669395.html
Sent from the OFBiz - Dev mailing list archive at Nabble.com.

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Thanks Taher.  I'm running Ubuntu so will have a go and let you know 
what happens.


Thanks
Sharan

On 03/06/15 14:05, Taher Alkhateeb wrote:

Hi Sharan,

Assuming you have a Linux box at hand, the simplest way would be the following:

First ensure that the right software installed e.g.:
apt-get install docbook xsltproc

Next test the section your are trying to generate with something like e.g.:
xsltproc -o dest.html 
/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl source.xml

The above command would generate an html document called dest.html from the 
docbook file source.xml. You can then open the file and browse. If it is not 
broken then we definitely have a problem in OFBiz, otherwise it could be just a 
bad source file.

A good link for resources on working with DocBook that helped me in the past is 
this one: https://help.ubuntu.com/community/DocBook

HTH

Taher Alkhateeb
- Original Message -

From: "Sharan Foga" 
To: dev@ofbiz.apache.org
Sent: Wednesday, 3 June, 2015 2:39:44 PM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Taher

That's a good point - no I didn't do that. I don't know how to do it -
do you have any instructions so I can try it?

Thanks
Sharan

On 03/06/15 12:20, Taher Alkhateeb wrote:

Hi Sharan,

Interesting, did you test whether the HR docs ran through DocBook's XSLT sheets 
but broke down when deployed on OFBiz? In other words is it valid and well 
formed XML in the first place?

Taher Alkhateeb

- Original Message -

From: "Sharan Foga" 
To: dev@ofbiz.apache.org
Sent: Wednesday, 3 June, 2015 12:53:18 PM
Subject: Re: Possible Documentation and help solutions - DITA

Yes that's right. It was written for the Webhelp branch but was done
using Docbook.

On 03/06/15 11:43, Jacques Le Roux wrote:

Le 03/06/2015 11:37, Sharan Foga a écrit :

Hi

My understanding is that a key problem is that the Docbook
implementation that we have isn't complete. (I noticed this when I
tried to copy in the HR documentation - a lot of the standard docbook
tags don't work.)

"the HR documentation" you mean the work done by Tom Burns?

Jacques


Thanks
Sharan

On 03/06/15 11:16, Taher Alkhateeb wrote:

Hi Ron, Paul and everyone,

So I did research on the available markup solutions for technical
documentation and I think I share Ron's view on DITA being the more
well equipped solution. With that being said, moving away from
DocBook means some substantial work for the framework to switch the
context-help screens from DocBook to DITA or any other solution.

So I am sure the community will make the right choice If we decided
to move. The more relevant question, however, is why move? The
effort it takes to switch must have an added value. Mind you DocBook
is mature and robust even though a bit old, and you can achieve
modularity with 

I am quite neutral to this issue and do not mind moving if someone
is willing to make the effort (and without breaking the context help
system). I would be more inclined to help If I can understand the
added value in magnitude (how would it change and improve what we
are doing now).

My 2 cents

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com
Sent: Wednesday, 3 June, 2015 11:47:52 AM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which
is a
wiki-like markup language. Unlike Markdown and all those others,
it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to
DocBook. To me
this is the best of all worlds. No specialist tools required for
editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler
 wrote:


Anne Rockley is one of the top DITA experts and her webinars are
excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a
webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her
concerns also
apply to regulated industries or business functions that are
regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Sharan, 

Assuming you have a Linux box at hand, the simplest way would be the following: 

First ensure that the right software installed e.g.: 
apt-get install docbook xsltproc 

Next test the section your are trying to generate with something like e.g.: 
xsltproc -o dest.html 
/usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.xsl source.xml 

The above command would generate an html document called dest.html from the 
docbook file source.xml. You can then open the file and browse. If it is not 
broken then we definitely have a problem in OFBiz, otherwise it could be just a 
bad source file. 

A good link for resources on working with DocBook that helped me in the past is 
this one: https://help.ubuntu.com/community/DocBook 

HTH 

Taher Alkhateeb 
- Original Message -

From: "Sharan Foga"  
To: dev@ofbiz.apache.org 
Sent: Wednesday, 3 June, 2015 2:39:44 PM 
Subject: Re: Possible Documentation and help solutions - DITA 

Hi Taher 

That's a good point - no I didn't do that. I don't know how to do it - 
do you have any instructions so I can try it? 

Thanks 
Sharan 

On 03/06/15 12:20, Taher Alkhateeb wrote: 
> Hi Sharan, 
> 
> Interesting, did you test whether the HR docs ran through DocBook's XSLT 
> sheets but broke down when deployed on OFBiz? In other words is it valid and 
> well formed XML in the first place? 
> 
> Taher Alkhateeb 
> 
> - Original Message - 
> 
> From: "Sharan Foga"  
> To: dev@ofbiz.apache.org 
> Sent: Wednesday, 3 June, 2015 12:53:18 PM 
> Subject: Re: Possible Documentation and help solutions - DITA 
> 
> Yes that's right. It was written for the Webhelp branch but was done 
> using Docbook. 
> 
> On 03/06/15 11:43, Jacques Le Roux wrote: 
>> Le 03/06/2015 11:37, Sharan Foga a écrit : 
>>> Hi 
>>> 
>>> My understanding is that a key problem is that the Docbook 
>>> implementation that we have isn't complete. (I noticed this when I 
>>> tried to copy in the HR documentation - a lot of the standard docbook 
>>> tags don't work.) 
>> "the HR documentation" you mean the work done by Tom Burns? 
>> 
>> Jacques 
>> 
>>> Thanks 
>>> Sharan 
>>> 
>>> On 03/06/15 11:16, Taher Alkhateeb wrote: 
>>>> Hi Ron, Paul and everyone, 
>>>> 
>>>> So I did research on the available markup solutions for technical 
>>>> documentation and I think I share Ron's view on DITA being the more 
>>>> well equipped solution. With that being said, moving away from 
>>>> DocBook means some substantial work for the framework to switch the 
>>>> context-help screens from DocBook to DITA or any other solution. 
>>>> 
>>>> So I am sure the community will make the right choice If we decided 
>>>> to move. The more relevant question, however, is why move? The 
>>>> effort it takes to switch must have an added value. Mind you DocBook 
>>>> is mature and robust even though a bit old, and you can achieve 
>>>> modularity with  
>>>> 
>>>> I am quite neutral to this issue and do not mind moving if someone 
>>>> is willing to make the effort (and without breaking the context help 
>>>> system). I would be more inclined to help If I can understand the 
>>>> added value in magnitude (how would it change and improve what we 
>>>> are doing now). 
>>>> 
>>>> My 2 cents 
>>>> 
>>>> Taher Alkhateeb 
>>>> 
>>>> - Original Message - 
>>>> 
>>>> From: "Paul Foxworthy"  
>>>> To: dev@ofbiz.apache.org, rwhee...@artifact-software.com 
>>>> Sent: Wednesday, 3 June, 2015 11:47:52 AM 
>>>> Subject: Re: Possible Documentation and help solutions - DITA 
>>>> 
>>>> Hi Ron, 
>>>> 
>>>> For serious use of DITA, would it be necessary to invest in specialist 
>>>> tools? That would be a real barrier for an open source project. 
>>>> 
>>>> I've have had good results in another project using AsciiDoc, which 
>>>> is a 
>>>> wiki-like markup language. Unlike Markdown and all those others, 
>>>> it's not 
>>>> limited to a brain-damaged subset of what you need in a manual. It can 
>>>> convey anything in DocBook, and AsciiDoc can be converted to 
>>>> DocBook. To me 
>>>> this is the best of all worlds. No specialist tools required for 
>>>> editing 
>>>> and maintenance, human-readable, but with the entire D

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Hi Taher

That's a good point - no I didn't do that. I don't know how to do it - 
do you have any instructions so I can try it?


Thanks
Sharan

On 03/06/15 12:20, Taher Alkhateeb wrote:

Hi Sharan,

Interesting, did you test whether the HR docs ran through DocBook's XSLT sheets 
but broke down when deployed on OFBiz? In other words is it valid and well 
formed XML in the first place?

Taher Alkhateeb

- Original Message -

From: "Sharan Foga" 
To: dev@ofbiz.apache.org
Sent: Wednesday, 3 June, 2015 12:53:18 PM
Subject: Re: Possible Documentation and help solutions - DITA

Yes that's right. It was written for the Webhelp branch but was done
using Docbook.

On 03/06/15 11:43, Jacques Le Roux wrote:

Le 03/06/2015 11:37, Sharan Foga a écrit :

Hi

My understanding is that a key problem is that the Docbook
implementation that we have isn't complete. (I noticed this when I
tried to copy in the HR documentation - a lot of the standard docbook
tags don't work.)

"the HR documentation" you mean the work done by Tom Burns?

Jacques


Thanks
Sharan

On 03/06/15 11:16, Taher Alkhateeb wrote:

Hi Ron, Paul and everyone,

So I did research on the available markup solutions for technical
documentation and I think I share Ron's view on DITA being the more
well equipped solution. With that being said, moving away from
DocBook means some substantial work for the framework to switch the
context-help screens from DocBook to DITA or any other solution.

So I am sure the community will make the right choice If we decided
to move. The more relevant question, however, is why move? The
effort it takes to switch must have an added value. Mind you DocBook
is mature and robust even though a bit old, and you can achieve
modularity with 

I am quite neutral to this issue and do not mind moving if someone
is willing to make the effort (and without breaking the context help
system). I would be more inclined to help If I can understand the
added value in magnitude (how would it change and improve what we
are doing now).

My 2 cents

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com
Sent: Wednesday, 3 June, 2015 11:47:52 AM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which
is a
wiki-like markup language. Unlike Markdown and all those others,
it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to
DocBook. To me
this is the best of all worlds. No specialist tools required for
editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler
 wrote:


Anne Rockley is one of the top DITA experts and her webinars are
excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a
webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her
concerns also
apply to regulated industries or business functions that are
regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>

sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"

blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Sharan, 

Interesting, did you test whether the HR docs ran through DocBook's XSLT sheets 
but broke down when deployed on OFBiz? In other words is it valid and well 
formed XML in the first place? 

Taher Alkhateeb 

- Original Message -

From: "Sharan Foga"  
To: dev@ofbiz.apache.org 
Sent: Wednesday, 3 June, 2015 12:53:18 PM 
Subject: Re: Possible Documentation and help solutions - DITA 

Yes that's right. It was written for the Webhelp branch but was done 
using Docbook. 

On 03/06/15 11:43, Jacques Le Roux wrote: 
> Le 03/06/2015 11:37, Sharan Foga a écrit : 
>> Hi 
>> 
>> My understanding is that a key problem is that the Docbook 
>> implementation that we have isn't complete. (I noticed this when I 
>> tried to copy in the HR documentation - a lot of the standard docbook 
>> tags don't work.) 
> 
> "the HR documentation" you mean the work done by Tom Burns? 
> 
> Jacques 
> 
>> 
>> Thanks 
>> Sharan 
>> 
>> On 03/06/15 11:16, Taher Alkhateeb wrote: 
>>> Hi Ron, Paul and everyone, 
>>> 
>>> So I did research on the available markup solutions for technical 
>>> documentation and I think I share Ron's view on DITA being the more 
>>> well equipped solution. With that being said, moving away from 
>>> DocBook means some substantial work for the framework to switch the 
>>> context-help screens from DocBook to DITA or any other solution. 
>>> 
>>> So I am sure the community will make the right choice If we decided 
>>> to move. The more relevant question, however, is why move? The 
>>> effort it takes to switch must have an added value. Mind you DocBook 
>>> is mature and robust even though a bit old, and you can achieve 
>>> modularity with  
>>> 
>>> I am quite neutral to this issue and do not mind moving if someone 
>>> is willing to make the effort (and without breaking the context help 
>>> system). I would be more inclined to help If I can understand the 
>>> added value in magnitude (how would it change and improve what we 
>>> are doing now). 
>>> 
>>> My 2 cents 
>>> 
>>> Taher Alkhateeb 
>>> 
>>> - Original Message - 
>>> 
>>> From: "Paul Foxworthy"  
>>> To: dev@ofbiz.apache.org, rwhee...@artifact-software.com 
>>> Sent: Wednesday, 3 June, 2015 11:47:52 AM 
>>> Subject: Re: Possible Documentation and help solutions - DITA 
>>> 
>>> Hi Ron, 
>>> 
>>> For serious use of DITA, would it be necessary to invest in specialist 
>>> tools? That would be a real barrier for an open source project. 
>>> 
>>> I've have had good results in another project using AsciiDoc, which 
>>> is a 
>>> wiki-like markup language. Unlike Markdown and all those others, 
>>> it's not 
>>> limited to a brain-damaged subset of what you need in a manual. It can 
>>> convey anything in DocBook, and AsciiDoc can be converted to 
>>> DocBook. To me 
>>> this is the best of all worlds. No specialist tools required for 
>>> editing 
>>> and maintenance, human-readable, but with the entire DocBook toolchain 
>>> available. pandoc (pandoc.org) can translate DocBook to a huge list of 
>>> other structured formats. 
>>> 
>>> Thanks 
>>> 
>>> Paul Foxworthy 
>>> 
>>> 
>>> On 3 June 2015 at 03:28, Ron Wheeler 
>>>  wrote: 
>>> 
>>>> Anne Rockley is one of the top DITA experts and her webinars are 
>>>> excellent. 
>>>> If you want to see how DITA could help improve the production and 
>>>> utilization of documentation for OFBiz, you might look for a 
>>>> webinar that 
>>>> relates to your particular concerns. 
>>>> 
>>>> She is an expert in the pharmaceutical area but a lot of her 
>>>> concerns also 
>>>> apply to regulated industries or business functions that are 
>>>> regulated such 
>>>> as accounting (localization is a common issue). 
>>>> 
>>>> 19 June - Join Charles Cooper at ETC for his session on Software, 
>>>> Documentation and Agile Development < 
>>>> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&a

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Yes that's right. It was written for the Webhelp branch but was done 
using Docbook.


On 03/06/15 11:43, Jacques Le Roux wrote:

Le 03/06/2015 11:37, Sharan Foga a écrit :

Hi

My understanding is that a key problem is that the Docbook 
implementation that we have isn't complete. (I noticed this when I 
tried to copy in the HR documentation - a lot of the standard docbook 
tags don't work.)


"the HR documentation" you mean the work done by Tom Burns?

Jacques



Thanks
Sharan

On 03/06/15 11:16, Taher Alkhateeb wrote:

Hi Ron, Paul and everyone,

So I did research on the available markup solutions for technical 
documentation and I think I share Ron's view on DITA being the more 
well equipped solution. With that being said, moving away from 
DocBook means some substantial work for the framework to switch the 
context-help screens from DocBook to DITA or any other solution.


So I am sure the community will make the right choice If we decided 
to move. The more relevant question, however, is why move? The 
effort it takes to switch must have an added value. Mind you DocBook 
is mature and robust even though a bit old, and you can achieve 
modularity with 


I am quite neutral to this issue and do not mind moving if someone 
is willing to make the effort (and without breaking the context help 
system). I would be more inclined to help If I can understand the 
added value in magnitude (how would it change and improve what we 
are doing now).


My 2 cents

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com
Sent: Wednesday, 3 June, 2015 11:47:52 AM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which 
is a
wiki-like markup language. Unlike Markdown and all those others, 
it's not

limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to 
DocBook. To me
this is the best of all worlds. No specialist tools required for 
editing

and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler 
 wrote:


Anne Rockley is one of the top DITA experts and her webinars are 
excellent.

If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a 
webinar that

relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her 
concerns also
apply to regulated industries or business functions that are 
regulated such

as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 


sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>" 


blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279> 







<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 





*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of t

Re: Possible Documentation and help solutions - DITA

[Jacques Le Roux]

Le 03/06/2015 11:37, Sharan Foga a écrit :

Hi

My understanding is that a key problem is that the Docbook implementation that we have isn't complete. (I noticed this when I tried to copy in the 
HR documentation - a lot of the standard docbook tags don't work.)


"the HR documentation" you mean the work done by Tom Burns?

Jacques



Thanks
Sharan

On 03/06/15 11:16, Taher Alkhateeb wrote:

Hi Ron, Paul and everyone,

So I did research on the available markup solutions for technical documentation and I think I share Ron's view on DITA being the more well equipped 
solution. With that being said, moving away from DocBook means some substantial work for the framework to switch the context-help screens from 
DocBook to DITA or any other solution.


So I am sure the community will make the right choice If we decided to move. The more relevant question, however, is why move? The effort it takes 
to switch must have an added value. Mind you DocBook is mature and robust even though a bit old, and you can achieve modularity with 


I am quite neutral to this issue and do not mind moving if someone is willing to make the effort (and without breaking the context help system). I 
would be more inclined to help If I can understand the added value in magnitude (how would it change and improve what we are doing now).


My 2 cents

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com
Sent: Wednesday, 3 June, 2015 11:47:52 AM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me
this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  wrote:


Anne Rockley is one of the top DITA experts and her webinars are excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her concerns also
apply to regulated industries or business functions that are regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 


sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>" 


blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279> 







<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==> 





*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing Content
in Life Sciences and Healthcare Survey <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhA

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Hi

My understanding is that a key problem is that the Docbook 
implementation that we have isn't complete. (I noticed this when I tried 
to copy in the HR documentation - a lot of the standard docbook tags 
don't work.)


Thanks
Sharan

On 03/06/15 11:16, Taher Alkhateeb wrote:

Hi Ron, Paul and everyone,

So I did research on the available markup solutions for technical documentation 
and I think I share Ron's view on DITA being the more well equipped solution. 
With that being said, moving away from DocBook means some substantial work for 
the framework to switch the context-help screens from DocBook to DITA or any 
other solution.

So I am sure the community will make the right choice If we decided to move. The more 
relevant question, however, is why move? The effort it takes to switch must have an 
added value. Mind you DocBook is mature and robust even though a bit old, and you can 
achieve modularity with 

I am quite neutral to this issue and do not mind moving if someone is willing 
to make the effort (and without breaking the context help system). I would be 
more inclined to help If I can understand the added value in magnitude (how 
would it change and improve what we are doing now).

My 2 cents

Taher Alkhateeb

- Original Message -

From: "Paul Foxworthy" 
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com
Sent: Wednesday, 3 June, 2015 11:47:52 AM
Subject: Re: Possible Documentation and help solutions - DITA

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me
this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  wrote:


Anne Rockley is one of the top DITA experts and her webinars are excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her concerns also
apply to regulated industries or business functions that are regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"
blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279>





<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>



*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing Content
in Life Sciences and Healthcare Survey <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1RuOIAV_DUctsI2wCR4

Re: Possible Documentation and help solutions - DITA

[Taher Alkhateeb]

Hi Ron, Paul and everyone, 

So I did research on the available markup solutions for technical documentation 
and I think I share Ron's view on DITA being the more well equipped solution. 
With that being said, moving away from DocBook means some substantial work for 
the framework to switch the context-help screens from DocBook to DITA or any 
other solution. 

So I am sure the community will make the right choice If we decided to move. 
The more relevant question, however, is why move? The effort it takes to switch 
must have an added value. Mind you DocBook is mature and robust even though a 
bit old, and you can achieve modularity with  

I am quite neutral to this issue and do not mind moving if someone is willing 
to make the effort (and without breaking the context help system). I would be 
more inclined to help If I can understand the added value in magnitude (how 
would it change and improve what we are doing now). 

My 2 cents 

Taher Alkhateeb 

- Original Message -

From: "Paul Foxworthy"  
To: dev@ofbiz.apache.org, rwhee...@artifact-software.com 
Sent: Wednesday, 3 June, 2015 11:47:52 AM 
Subject: Re: Possible Documentation and help solutions - DITA 

Hi Ron, 

For serious use of DITA, would it be necessary to invest in specialist 
tools? That would be a real barrier for an open source project. 

I've have had good results in another project using AsciiDoc, which is a 
wiki-like markup language. Unlike Markdown and all those others, it's not 
limited to a brain-damaged subset of what you need in a manual. It can 
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me 
this is the best of all worlds. No specialist tools required for editing 
and maintenance, human-readable, but with the entire DocBook toolchain 
available. pandoc (pandoc.org) can translate DocBook to a huge list of 
other structured formats. 

Thanks 

Paul Foxworthy 


On 3 June 2015 at 03:28, Ron Wheeler  wrote: 

> Anne Rockley is one of the top DITA experts and her webinars are excellent. 
> If you want to see how DITA could help improve the production and 
> utilization of documentation for OFBiz, you might look for a webinar that 
> relates to your particular concerns. 
> 
> She is an expert in the pharmaceutical area but a lot of her concerns also 
> apply to regulated industries or business functions that are regulated such 
> as accounting (localization is a common issue). 
> 
> 19 June - Join Charles Cooper at ETC for his session on Software, 
> Documentation and Agile Development < 
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
>  
> sounds like something that might be relevant to us. 
> 
> The "Intelligent Content: What Does "Reusable" Mean? < 
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"
>  
> blog post addresses Jacques' question about how to use a library of 
> reusable content much better than I did. 
> 
> 
> Ron 
> 
> 
> 
>  Forwarded Message  
> 
> 
> Having trouble viewing this email? Click here < 
> http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279>
>  
> 
> 
> 
> 
> 
> < 
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
>  
> 
> 
> 
> * 
> * 
> *Webinars with Ann Rockley* 
> ** 
> *Recently Recorded Webinars* 
> 
> Results of the Second Annual Challenges of Creating and Managing Content 
> in Life Sciences and Healthcare Survey < 
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1

Re: Possible Documentation and help solutions - DITA

[Sharan Foga]

Hi Paul

I've got some other threads open on the user mailing lists about 
documentation strategies because I wanted to get some feedback from the 
user community and I'm a bit unclear about what you are suggesting.


 * Is it about replacing the Docbook implementation we currently have
   within OFBiz with something else (e.g Asciidoc)?
 * Is it about extracting the Docbook content from what we currently
   have in OFBiz and then generating it into another format that we
   could possibly re-introduce?
 * Or is it something else?


Thanks
Sharan


On 03/06/15 10:47, Paul Foxworthy wrote:

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me
this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  wrote:


Anne Rockley is one of the top DITA experts and her webinars are excellent.
If you want to see how DITA could help improve the production and
utilization of documentation for OFBiz, you might look for a webinar that
relates to your particular concerns.

She is an expert in the pharmaceutical area but a lot of her concerns also
apply to regulated industries or business functions that are regulated such
as accounting (localization is a common issue).

19 June - Join Charles Cooper at ETC for his session on Software,
Documentation and Agile Development <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
sounds like something that might be relevant to us.

The "Intelligent Content: What Does "Reusable" Mean? <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"
blog post addresses Jacques' question about how to use a library of
reusable content much better than I did.


Ron



 Forwarded Message 


Having trouble viewing this email? Click here <
http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279>





<
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>



*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing Content
in Life Sciences and Healthcare Survey <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1RuOIAV_DUctsI2wCR4toOjyKztJhEoLjdTD4Y1Ren2vX3ZehMrhjBScQO1s5npvjaGD4gMUa2M=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
Localizing Regulated Content While Saving Time and Money <
http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVBVnHwvucfHT2zNvF1yPKz-NSvdYGJIul-7dtewqWjcn18DV-CMGgiz67VaaXrAnbGxcEphlVOUfA7iyRqmz3MJOvS60jTD9VX9GWA0F4hmIg-gVS8NhsxfPiZWO0IKTzMzMr2h12horjIiz66wAcvRqjmkzh3Wj4g==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
Bridging Pharma Content Silos: Managing Content from Clinical Through
Labeling and Marketing 

Intelligently Managing the Complexities of the Core Data Sheet <
https://www.brighttalk.com/webcast/9273/146091>


*Upcoming Events and Presentations*

*LocWorld 28 - Localization World 2015 in Berlin, Germany*

03 June - Join Ann Rockley and others

Re: Possible Documentation and help solutions - DITA

[Paul Foxworthy]

Hi Ron,

For serious use of DITA, would it be necessary to invest in specialist
tools? That would be a real barrier for an open source project.

I've have had good results in another project using AsciiDoc, which is a
wiki-like markup language. Unlike Markdown and all those others, it's not
limited to a brain-damaged subset of what you need in a manual. It can
convey anything in DocBook, and AsciiDoc can be converted to DocBook. To me
this is the best of all worlds. No specialist tools required for editing
and maintenance, human-readable, but with the entire DocBook toolchain
available. pandoc (pandoc.org) can translate DocBook to a huge list of
other structured formats.

Thanks

Paul Foxworthy


On 3 June 2015 at 03:28, Ron Wheeler  wrote:

> Anne Rockley is one of the top DITA experts and her webinars are excellent.
> If you want to see how DITA could help improve the production and
> utilization of documentation for OFBiz, you might look for a webinar that
> relates to your particular concerns.
>
> She is an expert in the pharmaceutical area but a lot of her concerns also
> apply to regulated industries or business functions that are regulated such
> as accounting (localization is a common issue).
>
> 19 June - Join Charles Cooper at ETC for his session on Software,
> Documentation and Agile Development <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNrluDdwSUd4f9WqyMtVtzdU4iUvYLE8gHYaxHEp7GiHnXU91MZQlCvJQmSSxqW1qMS90KgOVj0jCZz7XUq4o8y2HrSIpCCC1pvty9zVdsbWad85_8zRNttYSNLZaji3a3&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
> sounds like something that might be relevant to us.
>
> The "Intelligent Content: What Does "Reusable" Mean? <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIKcq5t7_sGa_YrYZcPP_xveuxMDyIJOq0NL2T01f13TSS56TTCCpGDrgsZf35E_GQhKjAqaQZ-eok4xWgT8JGSSCXzPYsUu-Hf0EpZ6IVS8zUiX7UVwvOA9NZFpMGb5bQnx9PgZv04uStMHJAgB1UJqa-g_s8BLBacNZSXegB5Gov7l9r-kfBIvkx4sU3NZE7di-GHeu_0mlNG7OV1QMKYJ9yF0Mqoc01uZTFw-QnQzkdObw-tX4mo=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>"
> blog post addresses Jacques' question about how to use a library of
> reusable content much better than I did.
>
>
> Ron
>
>
>
>  Forwarded Message 
>
>
> Having trouble viewing this email? Click here <
> http://campaign.r20.constantcontact.com/render?ca=fcaa0b03-86df-4c67-bf37-d645ce38f8ea&c=8f7153c0-e1fa-11e4-a4b6-d4ae52844279&ch=8f9c3450-e1fa-11e4-a4de-d4ae52844279>
>
>
>
>
>
> <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVIz0RR4E3aPj1d7wqoOmD03Aya0ayMj7-AgoYI1Q8jMzgxi5OPHr-9kecHlyI_KcNsuYThWc0tgCI1JWLCg1_wkaYdETLixWpz_mA3YqzY4d90I3-fyVpA4=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==>
>
>
>
> *
> *
> *Webinars with Ann Rockley*
> **
> *Recently Recorded Webinars*
>
> Results of the Second Annual Challenges of Creating and Managing Content
> in Life Sciences and Healthcare Survey <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVPAoxrJqBq8BsuVDhC1MXkBPtRuVcjavHIB69fqUJQc0XInBL8j6m1OqwvcE50qH7AClNrk1L6KHec3LO3_4IfyxzAq2BCTYgMrHmQvnEj-oC8_1T6u_4umpDR5elMhfypJuzjQzmNZZH06irReDYNKwY9uEhJ6HiAzfsAyyGIPuAQbH0J9taNgHIHV87AQlvd9bRzEFqHHa1RuOIAV_DUctsI2wCR4toOjyKztJhEoLjdTD4Y1Ren2vX3ZehMrhjBScQO1s5npvjaGD4gMUa2M=&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
> >
>
> Localizing Regulated Content While Saving Time and Money <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVBVnHwvucfHT2zNvF1yPKz-NSvdYGJIul-7dtewqWjcn18DV-CMGgiz67VaaXrAnbGxcEphlVOUfA7iyRqmz3MJOvS60jTD9VX9GWA0F4hmIg-gVS8NhsxfPiZWO0IKTzMzMr2h12horjIiz66wAcvRqjmkzh3Wj4g==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
> >
>
> Bridging Pharma Content Silos: Managing Content from Clinical Through
> Labeling and Marketing 
>
> Intelligently Managing the Complexities of the Core Data Sheet <
> https://www.brighttalk.com/webcast/9273/146091>
>
>
> *Upcoming Events and Presentations*
>
> *LocWorld 28 - Localization World 2015 in Berlin, Germany*
>
> 03 June - Join Ann Rockley and others for the Life Sciences Business
> Roundtable <
> http://r20.rs6.net/tn.jsp?f=001R3KFEYl9u4YXuWSn36IeeWypLQwhAjSruFHWEtyCLXWNyrGpgLHuVGCO8y5J0LCNKkQku0rPdubcmGs9xZj-nU756cGD8h9GUq0niuPwDarZHhfLSyhyXG-TwKft5pJ4gYmRgftjttrmcQ_Pdb-g1syVUc4058f35z53DcsvP_-BV25Cw1yUYd2db4QnPe1d0JsoaDXGKTxnkedl-GtzB6zLwWhkZWerXTd1OF3vk8PXHCuojL_CRQ==&c=ji_CL3u5I7wrq8E-36UYX-p1saH9RZwBYzb34hER04NnWuVlGp420g==&ch=tgy69stNq6UApiTWE6T_W92FpfW1afoA1FjL-2Y35bbnhPW-qnWbDA==
> >
>
>
> 04 June - Join Charles Cooper

Possible Documentation and help solutions - DITA

[Ron Wheeler]

Anne Rockley is one of the top DITA experts and her webinars are excellent.
If you want to see how DITA could help improve the production and 
utilization of documentation for OFBiz, you might look for a webinar 
that relates to your particular concerns.


She is an expert in the pharmaceutical area but a lot of her concerns 
also apply to regulated industries or business functions that are 
regulated such as accounting (localization is a common issue).


19 June - Join Charles Cooper at ETC for his session on Software, 
Documentation and Agile Development 
 
sounds like something that might be relevant to us.


The "Intelligent Content: What Does "Reusable" Mean? 
" 
blog post addresses Jacques' question about how to use a library of 
reusable content much better than I did.



Ron



 Forwarded Message 


Having trouble viewing this email? Click here 
 






 




*
*
*Webinars with Ann Rockley*
**
*Recently Recorded Webinars*

Results of the Second Annual Challenges of Creating and Managing Content 
in Life Sciences and Healthcare Survey 



Localizing Regulated Content While Saving Time and Money 



Bridging Pharma Content Silos: Managing Content from Clinical Through 
Labeling and Marketing 


Intelligently Managing the Complexities of the Core Data Sheet 




*Upcoming Events and Presentations*

*LocWorld 28 - Localization World 2015 in Berlin, Germany*

03 June - Join Ann Rockley and others for the Life Sciences Business 
Roundtable 




04 June - Join Charles Cooper for his session on Content Strategy for 
Advanced Display and Localization 



04 June - Join Charles Cooper, Diana Ballard, Laurence Dansokho and 
Michael Rosinski for Smart Products and Connected Devices Require 
Intelligent Localized Content