You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@openoffice.apache.org by Jing Bai <ji...@gmail.com> on 2012/03/16 09:11:19 UTC

Re: Symphony documentation for AOO?

Seems many people would agree that WIKI solution is a good one. Does anyone
know where we can find the WIKI hardware and platform resources in our
community? How could we setup one wiki platform for ourselves to host the
help?

Best regards
Betsy Bai
On Wed, Feb 29, 2012 at 12:05 PM, Jean Weber <je...@gmail.com> wrote:

> I haven't had time to look at the tutorials themselves, but the list
> of contents looks very good. I would definitely like to see them
> become part of the official user documentation for AOO. The main
> questions for the group are when and where these materials will be
> available for volunteers to work on them, and who is going to do the
> actual work of updating them for AOO.
>
> I will say right now that I am not going to be the person coordinating
> the work (on these or other user-oriented documents), nor do I intend
> to do much if any of the work myself. I'm asking questions in the hope
> of nudging others into action, but beyond that I don't intend to go.
> (Of course, I might change my mind later, but don't count on it.) I
> have books of my own to write, and limited time for writing.
>
> --Jean
>
> On Mon, Feb 20, 2012 at 16:25, Jing Bai <ji...@gmail.com> wrote:
> > Regarding on the user guide, actually, we have some getting started
> > tutorials for Symphony before. Here is the link, maybe this is a
> reference
> > for our AOO user guide? The guide is a tutorials that help user to
> getting
> > started. Not all the help topics would be listed but some key one.
> >
> > Document tutorials:
> >
> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/documents_tutorial/frameset.html
> > Presentation tutorials:
> >
> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/presentations_tutorial/frameset.html
> > Spreadsheet tutorials:
> >
> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/spreadsheets_tutorial/frameset.html
> >
> > Thoughts?
> >
> > On Sat, Feb 18, 2012 at 5:19 AM, Jean Weber <je...@gmail.com> wrote:
> >
> >> On Sat, Feb 18, 2012 at 01:25, Jing Bai <ji...@gmail.com> wrote:
> >> > The wikis we use are xpages wikis that run on Domino servers. USA IDC
> >> hosts
> >> > the WIKI for all Lotus products, such as Lotus Connections, LotusLive,
> >> > Symphony, Sametime and etc. There is a STSM named John Hunt who wrote
> the
> >> > code to transform DITA into DXML (the xpages source code) for wiki
> pages.
> >> > Here is one demo on how we publish the product documentation in Wikis:
> >> >
> >>
> http://cdcontent.lotus.com/lotused/lnl_doc-to-wiki_enablement/lnl_doc-to-wiki_enablement.htm
> >> >
> >> > Publishing product documentation in wikis lets us provide accessible
> >> > documentation in a friendly and easy-to-use format where customers can
> >> > comment directly against topics and even update the instructions.
> Writers
> >> > can review that feedback and incorporate appropriate changes into
> source
> >> > files for the next product release. Using wikis lets IBM consolidate
> >> > product information while fostering a greater sense of community
> between
> >> > IBMers, business partners, and customers.
> >> > We may reuse the WIKI platform in USA IDC, setup one area for AOO if
> >> > necessary. I would like to ask USA IDC, if this is feasible.
> >> >
> >> >
> >> > On Fri, Feb 17, 2012, Jing Bai wrote:
> >> >
> >> >> In the future, we would like to promote the WIKI help console to the
> >> >> community if appropriate. Since it is more collaborative, but to
> make it
> >> >> happen, the file format would be changed into DITA, if anyone is
> >> >> interesting in it, I would like to provide an article on its details.
> >>
> >>
> >> Betsy,
> >> Thanks for your replies.
> >>
> >> I think the wiki solution is a good one (especially since most of it
> >> exists now and only needs to be revised for AOO), so I hope it can be
> >> set up and interested people can learn how to use it. Several new
> >> members of the group have expressed interest and even experience in
> >> working with DITA.
> >>
> >> However, I also think many of the volunteers who worked on user guides
> >> for OOo -- if they choose to work on AOO docs -- prefer to work in AOO
> >> itself and produce user guides that demonstrate (some of) what one can
> >> do with the product as a publishing system. So there is scope for the
> >> online docs and user guides. The user guides could be derived from the
> >> online docs (with an Apache license) or derived from the existing OOo
> >> docs (with a CC-BY license and probably hosted elsewhere, as discussed
> >> some time ago on this list).
> >>
> >> Aside: I know that it is possible to produce book output from DITA
> >> files, but in my experience online material doesn't always produce the
> >> most useful content for a sequential document like a book. In other
> >> words, the issues are editorial, not technical.
> >>
> >> Which way we go, and indeed whether people want to do user guides at
> >> all, depends on who wants to get involved. For the record, I much
> >> prefer to work in AOO itself, but I am interested in learning about
> >> the DITA/wiki system and investigating content reuse possibilities.
> >>
> >> --Jean
> >>
>

Re: Symphony documentation for AOO?

Posted by Jingbai <ji...@gmail.com>.
I think we could think about how to import the AOO help in xhp format into one of the Wiki system that Apache supports. Since that would be the base for customization. Are there Urls or docs for the wiki system? 

Betsy Bai

发自我的 iPhone

在 2012-3-16,下午11:09,Rob Weir <ro...@apache.org> 写道:

> On Fri, Mar 16, 2012 at 11:08 AM, Rob Weir <ro...@apache.org> wrote:
>> On Fri, Mar 16, 2012 at 4:11 AM, Jing Bai <ji...@gmail.com> wrote:
>>> Seems many people would agree that WIKI solution is a good one. Does anyone
>>> know where we can find the WIKI hardware and platform resources in our
>>> community? How could we setup one wiki platform for ourselves to host the
>>> help?
>>> 
>> 
>> At Apache we have access to ConfluenceWiki and Media Wiki systems.
>> What does your help system use? Is there any way to export or convert
>> the help so it works with one of these systems?
>> 
> 
> I think Apache supports MoinMoin wiki as well, though we don't
> currently use it in this project.
> 
>> -Rob
>> 
>>> Best regards
>>> Betsy Bai
>>> On Wed, Feb 29, 2012 at 12:05 PM, Jean Weber <je...@gmail.com> wrote:
>>> 
>>>> I haven't had time to look at the tutorials themselves, but the list
>>>> of contents looks very good. I would definitely like to see them
>>>> become part of the official user documentation for AOO. The main
>>>> questions for the group are when and where these materials will be
>>>> available for volunteers to work on them, and who is going to do the
>>>> actual work of updating them for AOO.
>>>> 
>>>> I will say right now that I am not going to be the person coordinating
>>>> the work (on these or other user-oriented documents), nor do I intend
>>>> to do much if any of the work myself. I'm asking questions in the hope
>>>> of nudging others into action, but beyond that I don't intend to go.
>>>> (Of course, I might change my mind later, but don't count on it.) I
>>>> have books of my own to write, and limited time for writing.
>>>> 
>>>> --Jean
>>>> 
>>>> On Mon, Feb 20, 2012 at 16:25, Jing Bai <ji...@gmail.com> wrote:
>>>>> Regarding on the user guide, actually, we have some getting started
>>>>> tutorials for Symphony before. Here is the link, maybe this is a
>>>> reference
>>>>> for our AOO user guide? The guide is a tutorials that help user to
>>>> getting
>>>>> started. Not all the help topics would be listed but some key one.
>>>>> 
>>>>> Document tutorials:
>>>>> 
>>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/documents_tutorial/frameset.html
>>>>> Presentation tutorials:
>>>>> 
>>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/presentations_tutorial/frameset.html
>>>>> Spreadsheet tutorials:
>>>>> 
>>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/spreadsheets_tutorial/frameset.html
>>>>> 
>>>>> Thoughts?
>>>>> 
>>>>> On Sat, Feb 18, 2012 at 5:19 AM, Jean Weber <je...@gmail.com> wrote:
>>>>> 
>>>>>> On Sat, Feb 18, 2012 at 01:25, Jing Bai <ji...@gmail.com> wrote:
>>>>>>> The wikis we use are xpages wikis that run on Domino servers. USA IDC
>>>>>> hosts
>>>>>>> the WIKI for all Lotus products, such as Lotus Connections, LotusLive,
>>>>>>> Symphony, Sametime and etc. There is a STSM named John Hunt who wrote
>>>> the
>>>>>>> code to transform DITA into DXML (the xpages source code) for wiki
>>>> pages.
>>>>>>> Here is one demo on how we publish the product documentation in Wikis:
>>>>>>> 
>>>>>> 
>>>> http://cdcontent.lotus.com/lotused/lnl_doc-to-wiki_enablement/lnl_doc-to-wiki_enablement.htm
>>>>>>> 
>>>>>>> Publishing product documentation in wikis lets us provide accessible
>>>>>>> documentation in a friendly and easy-to-use format where customers can
>>>>>>> comment directly against topics and even update the instructions.
>>>> Writers
>>>>>>> can review that feedback and incorporate appropriate changes into
>>>> source
>>>>>>> files for the next product release. Using wikis lets IBM consolidate
>>>>>>> product information while fostering a greater sense of community
>>>> between
>>>>>>> IBMers, business partners, and customers.
>>>>>>> We may reuse the WIKI platform in USA IDC, setup one area for AOO if
>>>>>>> necessary. I would like to ask USA IDC, if this is feasible.
>>>>>>> 
>>>>>>> 
>>>>>>> On Fri, Feb 17, 2012, Jing Bai wrote:
>>>>>>> 
>>>>>>>> In the future, we would like to promote the WIKI help console to the
>>>>>>>> community if appropriate. Since it is more collaborative, but to
>>>> make it
>>>>>>>> happen, the file format would be changed into DITA, if anyone is
>>>>>>>> interesting in it, I would like to provide an article on its details.
>>>>>> 
>>>>>> 
>>>>>> Betsy,
>>>>>> Thanks for your replies.
>>>>>> 
>>>>>> I think the wiki solution is a good one (especially since most of it
>>>>>> exists now and only needs to be revised for AOO), so I hope it can be
>>>>>> set up and interested people can learn how to use it. Several new
>>>>>> members of the group have expressed interest and even experience in
>>>>>> working with DITA.
>>>>>> 
>>>>>> However, I also think many of the volunteers who worked on user guides
>>>>>> for OOo -- if they choose to work on AOO docs -- prefer to work in AOO
>>>>>> itself and produce user guides that demonstrate (some of) what one can
>>>>>> do with the product as a publishing system. So there is scope for the
>>>>>> online docs and user guides. The user guides could be derived from the
>>>>>> online docs (with an Apache license) or derived from the existing OOo
>>>>>> docs (with a CC-BY license and probably hosted elsewhere, as discussed
>>>>>> some time ago on this list).
>>>>>> 
>>>>>> Aside: I know that it is possible to produce book output from DITA
>>>>>> files, but in my experience online material doesn't always produce the
>>>>>> most useful content for a sequential document like a book. In other
>>>>>> words, the issues are editorial, not technical.
>>>>>> 
>>>>>> Which way we go, and indeed whether people want to do user guides at
>>>>>> all, depends on who wants to get involved. For the record, I much
>>>>>> prefer to work in AOO itself, but I am interested in learning about
>>>>>> the DITA/wiki system and investigating content reuse possibilities.
>>>>>> 
>>>>>> --Jean
>>>>>> 
>>>> 

Re: Symphony documentation for AOO?

Posted by Rob Weir <ro...@apache.org>.
On Fri, Mar 16, 2012 at 11:08 AM, Rob Weir <ro...@apache.org> wrote:
> On Fri, Mar 16, 2012 at 4:11 AM, Jing Bai <ji...@gmail.com> wrote:
>> Seems many people would agree that WIKI solution is a good one. Does anyone
>> know where we can find the WIKI hardware and platform resources in our
>> community? How could we setup one wiki platform for ourselves to host the
>> help?
>>
>
> At Apache we have access to ConfluenceWiki and Media Wiki systems.
> What does your help system use? Is there any way to export or convert
> the help so it works with one of these systems?
>

I think Apache supports MoinMoin wiki as well, though we don't
currently use it in this project.

> -Rob
>
>> Best regards
>> Betsy Bai
>> On Wed, Feb 29, 2012 at 12:05 PM, Jean Weber <je...@gmail.com> wrote:
>>
>>> I haven't had time to look at the tutorials themselves, but the list
>>> of contents looks very good. I would definitely like to see them
>>> become part of the official user documentation for AOO. The main
>>> questions for the group are when and where these materials will be
>>> available for volunteers to work on them, and who is going to do the
>>> actual work of updating them for AOO.
>>>
>>> I will say right now that I am not going to be the person coordinating
>>> the work (on these or other user-oriented documents), nor do I intend
>>> to do much if any of the work myself. I'm asking questions in the hope
>>> of nudging others into action, but beyond that I don't intend to go.
>>> (Of course, I might change my mind later, but don't count on it.) I
>>> have books of my own to write, and limited time for writing.
>>>
>>> --Jean
>>>
>>> On Mon, Feb 20, 2012 at 16:25, Jing Bai <ji...@gmail.com> wrote:
>>> > Regarding on the user guide, actually, we have some getting started
>>> > tutorials for Symphony before. Here is the link, maybe this is a
>>> reference
>>> > for our AOO user guide? The guide is a tutorials that help user to
>>> getting
>>> > started. Not all the help topics would be listed but some key one.
>>> >
>>> > Document tutorials:
>>> >
>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/documents_tutorial/frameset.html
>>> > Presentation tutorials:
>>> >
>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/presentations_tutorial/frameset.html
>>> > Spreadsheet tutorials:
>>> >
>>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/spreadsheets_tutorial/frameset.html
>>> >
>>> > Thoughts?
>>> >
>>> > On Sat, Feb 18, 2012 at 5:19 AM, Jean Weber <je...@gmail.com> wrote:
>>> >
>>> >> On Sat, Feb 18, 2012 at 01:25, Jing Bai <ji...@gmail.com> wrote:
>>> >> > The wikis we use are xpages wikis that run on Domino servers. USA IDC
>>> >> hosts
>>> >> > the WIKI for all Lotus products, such as Lotus Connections, LotusLive,
>>> >> > Symphony, Sametime and etc. There is a STSM named John Hunt who wrote
>>> the
>>> >> > code to transform DITA into DXML (the xpages source code) for wiki
>>> pages.
>>> >> > Here is one demo on how we publish the product documentation in Wikis:
>>> >> >
>>> >>
>>> http://cdcontent.lotus.com/lotused/lnl_doc-to-wiki_enablement/lnl_doc-to-wiki_enablement.htm
>>> >> >
>>> >> > Publishing product documentation in wikis lets us provide accessible
>>> >> > documentation in a friendly and easy-to-use format where customers can
>>> >> > comment directly against topics and even update the instructions.
>>> Writers
>>> >> > can review that feedback and incorporate appropriate changes into
>>> source
>>> >> > files for the next product release. Using wikis lets IBM consolidate
>>> >> > product information while fostering a greater sense of community
>>> between
>>> >> > IBMers, business partners, and customers.
>>> >> > We may reuse the WIKI platform in USA IDC, setup one area for AOO if
>>> >> > necessary. I would like to ask USA IDC, if this is feasible.
>>> >> >
>>> >> >
>>> >> > On Fri, Feb 17, 2012, Jing Bai wrote:
>>> >> >
>>> >> >> In the future, we would like to promote the WIKI help console to the
>>> >> >> community if appropriate. Since it is more collaborative, but to
>>> make it
>>> >> >> happen, the file format would be changed into DITA, if anyone is
>>> >> >> interesting in it, I would like to provide an article on its details.
>>> >>
>>> >>
>>> >> Betsy,
>>> >> Thanks for your replies.
>>> >>
>>> >> I think the wiki solution is a good one (especially since most of it
>>> >> exists now and only needs to be revised for AOO), so I hope it can be
>>> >> set up and interested people can learn how to use it. Several new
>>> >> members of the group have expressed interest and even experience in
>>> >> working with DITA.
>>> >>
>>> >> However, I also think many of the volunteers who worked on user guides
>>> >> for OOo -- if they choose to work on AOO docs -- prefer to work in AOO
>>> >> itself and produce user guides that demonstrate (some of) what one can
>>> >> do with the product as a publishing system. So there is scope for the
>>> >> online docs and user guides. The user guides could be derived from the
>>> >> online docs (with an Apache license) or derived from the existing OOo
>>> >> docs (with a CC-BY license and probably hosted elsewhere, as discussed
>>> >> some time ago on this list).
>>> >>
>>> >> Aside: I know that it is possible to produce book output from DITA
>>> >> files, but in my experience online material doesn't always produce the
>>> >> most useful content for a sequential document like a book. In other
>>> >> words, the issues are editorial, not technical.
>>> >>
>>> >> Which way we go, and indeed whether people want to do user guides at
>>> >> all, depends on who wants to get involved. For the record, I much
>>> >> prefer to work in AOO itself, but I am interested in learning about
>>> >> the DITA/wiki system and investigating content reuse possibilities.
>>> >>
>>> >> --Jean
>>> >>
>>>

How to unsubscribe from this list

Posted by Carl Marcum <cm...@apache.org>.
C.J,

If you wish to unsubscribe from this mailing list send an email to:
  ooo-dev-unsubscribe@incubator.apache.org

On 03/16/2012 12:33 PM, C. J. Palmer wrote:
> Please no more E-Mails
>

Best regards,
Carl

RE: Symphony documentation for AOO?

Posted by "C. J. Palmer" <cj...@charter.net>.
Please no more E-Mails

-----Original Message-----
From: Jing Bai [mailto:jingbaibetsy@gmail.com] 
Sent: Friday, March 16, 2012 3:11 AM
To: ooo-dev@incubator.apache.org
Subject: Re: Symphony documentation for AOO?

Seems many people would agree that WIKI solution is a good one. Does anyone
know where we can find the WIKI hardware and platform resources in our
community? How could we setup one wiki platform for ourselves to host the
help?

Best regards
Betsy Bai
On Wed, Feb 29, 2012 at 12:05 PM, Jean Weber <je...@gmail.com> wrote:

> I haven't had time to look at the tutorials themselves, but the list
> of contents looks very good. I would definitely like to see them
> become part of the official user documentation for AOO. The main
> questions for the group are when and where these materials will be
> available for volunteers to work on them, and who is going to do the
> actual work of updating them for AOO.
>
> I will say right now that I am not going to be the person coordinating
> the work (on these or other user-oriented documents), nor do I intend
> to do much if any of the work myself. I'm asking questions in the hope
> of nudging others into action, but beyond that I don't intend to go.
> (Of course, I might change my mind later, but don't count on it.) I
> have books of my own to write, and limited time for writing.
>
> --Jean
>
> On Mon, Feb 20, 2012 at 16:25, Jing Bai <ji...@gmail.com> wrote:
> > Regarding on the user guide, actually, we have some getting started
> > tutorials for Symphony before. Here is the link, maybe this is a
> reference
> > for our AOO user guide? The guide is a tutorials that help user to
> getting
> > started. Not all the help topics would be listed but some key one.
> >
> > Document tutorials:
> >
>
http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/documen
ts_tutorial/frameset.html
> > Presentation tutorials:
> >
>
http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/present
ations_tutorial/frameset.html
> > Spreadsheet tutorials:
> >
>
http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/spreads
heets_tutorial/frameset.html
> >
> > Thoughts?
> >
> > On Sat, Feb 18, 2012 at 5:19 AM, Jean Weber <je...@gmail.com> wrote:
> >
> >> On Sat, Feb 18, 2012 at 01:25, Jing Bai <ji...@gmail.com> wrote:
> >> > The wikis we use are xpages wikis that run on Domino servers. USA IDC
> >> hosts
> >> > the WIKI for all Lotus products, such as Lotus Connections,
LotusLive,
> >> > Symphony, Sametime and etc. There is a STSM named John Hunt who wrote
> the
> >> > code to transform DITA into DXML (the xpages source code) for wiki
> pages.
> >> > Here is one demo on how we publish the product documentation in
Wikis:
> >> >
> >>
>
http://cdcontent.lotus.com/lotused/lnl_doc-to-wiki_enablement/lnl_doc-to-wik
i_enablement.htm
> >> >
> >> > Publishing product documentation in wikis lets us provide accessible
> >> > documentation in a friendly and easy-to-use format where customers
can
> >> > comment directly against topics and even update the instructions.
> Writers
> >> > can review that feedback and incorporate appropriate changes into
> source
> >> > files for the next product release. Using wikis lets IBM consolidate
> >> > product information while fostering a greater sense of community
> between
> >> > IBMers, business partners, and customers.
> >> > We may reuse the WIKI platform in USA IDC, setup one area for AOO if
> >> > necessary. I would like to ask USA IDC, if this is feasible.
> >> >
> >> >
> >> > On Fri, Feb 17, 2012, Jing Bai wrote:
> >> >
> >> >> In the future, we would like to promote the WIKI help console to the
> >> >> community if appropriate. Since it is more collaborative, but to
> make it
> >> >> happen, the file format would be changed into DITA, if anyone is
> >> >> interesting in it, I would like to provide an article on its
details.
> >>
> >>
> >> Betsy,
> >> Thanks for your replies.
> >>
> >> I think the wiki solution is a good one (especially since most of it
> >> exists now and only needs to be revised for AOO), so I hope it can be
> >> set up and interested people can learn how to use it. Several new
> >> members of the group have expressed interest and even experience in
> >> working with DITA.
> >>
> >> However, I also think many of the volunteers who worked on user guides
> >> for OOo -- if they choose to work on AOO docs -- prefer to work in AOO
> >> itself and produce user guides that demonstrate (some of) what one can
> >> do with the product as a publishing system. So there is scope for the
> >> online docs and user guides. The user guides could be derived from the
> >> online docs (with an Apache license) or derived from the existing OOo
> >> docs (with a CC-BY license and probably hosted elsewhere, as discussed
> >> some time ago on this list).
> >>
> >> Aside: I know that it is possible to produce book output from DITA
> >> files, but in my experience online material doesn't always produce the
> >> most useful content for a sequential document like a book. In other
> >> words, the issues are editorial, not technical.
> >>
> >> Which way we go, and indeed whether people want to do user guides at
> >> all, depends on who wants to get involved. For the record, I much
> >> prefer to work in AOO itself, but I am interested in learning about
> >> the DITA/wiki system and investigating content reuse possibilities.
> >>
> >> --Jean
> >>
>


Re: Symphony documentation for AOO?

Posted by Rob Weir <ro...@apache.org>.
On Fri, Mar 16, 2012 at 4:11 AM, Jing Bai <ji...@gmail.com> wrote:
> Seems many people would agree that WIKI solution is a good one. Does anyone
> know where we can find the WIKI hardware and platform resources in our
> community? How could we setup one wiki platform for ourselves to host the
> help?
>

At Apache we have access to ConfluenceWiki and Media Wiki systems.
What does your help system use? Is there any way to export or convert
the help so it works with one of these systems?

-Rob

> Best regards
> Betsy Bai
> On Wed, Feb 29, 2012 at 12:05 PM, Jean Weber <je...@gmail.com> wrote:
>
>> I haven't had time to look at the tutorials themselves, but the list
>> of contents looks very good. I would definitely like to see them
>> become part of the official user documentation for AOO. The main
>> questions for the group are when and where these materials will be
>> available for volunteers to work on them, and who is going to do the
>> actual work of updating them for AOO.
>>
>> I will say right now that I am not going to be the person coordinating
>> the work (on these or other user-oriented documents), nor do I intend
>> to do much if any of the work myself. I'm asking questions in the hope
>> of nudging others into action, but beyond that I don't intend to go.
>> (Of course, I might change my mind later, but don't count on it.) I
>> have books of my own to write, and limited time for writing.
>>
>> --Jean
>>
>> On Mon, Feb 20, 2012 at 16:25, Jing Bai <ji...@gmail.com> wrote:
>> > Regarding on the user guide, actually, we have some getting started
>> > tutorials for Symphony before. Here is the link, maybe this is a
>> reference
>> > for our AOO user guide? The guide is a tutorials that help user to
>> getting
>> > started. Not all the help topics would be listed but some key one.
>> >
>> > Document tutorials:
>> >
>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/documents_tutorial/frameset.html
>> > Presentation tutorials:
>> >
>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/presentations_tutorial/frameset.html
>> > Spreadsheet tutorials:
>> >
>> http://www-03.ibm.com/software/lotus/symphony/idcontents/tutorial/en/spreadsheets_tutorial/frameset.html
>> >
>> > Thoughts?
>> >
>> > On Sat, Feb 18, 2012 at 5:19 AM, Jean Weber <je...@gmail.com> wrote:
>> >
>> >> On Sat, Feb 18, 2012 at 01:25, Jing Bai <ji...@gmail.com> wrote:
>> >> > The wikis we use are xpages wikis that run on Domino servers. USA IDC
>> >> hosts
>> >> > the WIKI for all Lotus products, such as Lotus Connections, LotusLive,
>> >> > Symphony, Sametime and etc. There is a STSM named John Hunt who wrote
>> the
>> >> > code to transform DITA into DXML (the xpages source code) for wiki
>> pages.
>> >> > Here is one demo on how we publish the product documentation in Wikis:
>> >> >
>> >>
>> http://cdcontent.lotus.com/lotused/lnl_doc-to-wiki_enablement/lnl_doc-to-wiki_enablement.htm
>> >> >
>> >> > Publishing product documentation in wikis lets us provide accessible
>> >> > documentation in a friendly and easy-to-use format where customers can
>> >> > comment directly against topics and even update the instructions.
>> Writers
>> >> > can review that feedback and incorporate appropriate changes into
>> source
>> >> > files for the next product release. Using wikis lets IBM consolidate
>> >> > product information while fostering a greater sense of community
>> between
>> >> > IBMers, business partners, and customers.
>> >> > We may reuse the WIKI platform in USA IDC, setup one area for AOO if
>> >> > necessary. I would like to ask USA IDC, if this is feasible.
>> >> >
>> >> >
>> >> > On Fri, Feb 17, 2012, Jing Bai wrote:
>> >> >
>> >> >> In the future, we would like to promote the WIKI help console to the
>> >> >> community if appropriate. Since it is more collaborative, but to
>> make it
>> >> >> happen, the file format would be changed into DITA, if anyone is
>> >> >> interesting in it, I would like to provide an article on its details.
>> >>
>> >>
>> >> Betsy,
>> >> Thanks for your replies.
>> >>
>> >> I think the wiki solution is a good one (especially since most of it
>> >> exists now and only needs to be revised for AOO), so I hope it can be
>> >> set up and interested people can learn how to use it. Several new
>> >> members of the group have expressed interest and even experience in
>> >> working with DITA.
>> >>
>> >> However, I also think many of the volunteers who worked on user guides
>> >> for OOo -- if they choose to work on AOO docs -- prefer to work in AOO
>> >> itself and produce user guides that demonstrate (some of) what one can
>> >> do with the product as a publishing system. So there is scope for the
>> >> online docs and user guides. The user guides could be derived from the
>> >> online docs (with an Apache license) or derived from the existing OOo
>> >> docs (with a CC-BY license and probably hosted elsewhere, as discussed
>> >> some time ago on this list).
>> >>
>> >> Aside: I know that it is possible to produce book output from DITA
>> >> files, but in my experience online material doesn't always produce the
>> >> most useful content for a sequential document like a book. In other
>> >> words, the issues are editorial, not technical.
>> >>
>> >> Which way we go, and indeed whether people want to do user guides at
>> >> all, depends on who wants to get involved. For the record, I much
>> >> prefer to work in AOO itself, but I am interested in learning about
>> >> the DITA/wiki system and investigating content reuse possibilities.
>> >>
>> >> --Jean
>> >>
>>

Re: Symphony documentation for AOO?

Posted by Guy Waterval <wa...@gmail.com>.
Hello Rob,

2012/3/17 Rob Weir <ro...@apache.org>

>
> The format isn't the issue. The issue is the editing environment,
> right? If you could use OpenOffice as your editor and easily save it
> to DITA, or Wiki format, then that would be OK.  Do you agree?
>
Yes, I do.
That would be nice to have the possibility to create basis documents
directly in AOO in a form easily exportable to the other formats. Of course
this requests some instructions from professionnal technical writers,
template, etc. to produce basis documents which fit the needs with a
minimum of supplementary work. In a teamwork, this approach could also have
the advantage to implicate more people who  know the habits and
 difficulties generally encountered by the end users during their daily use
of the tool.
Easy to say .... but perhaps not so easy to do, of course.
A+
-- 
gw

Re: Symphony documentation for AOO?

Posted by Rob Weir <ro...@apache.org>.
On Sat, Mar 17, 2012 at 12:43 AM, Jingbai <ji...@gmail.com> wrote:
> In Symphony,
> 1) the editing env is a tool called ID workbench for editing Dita files
> 2) Documentation source file format is Dita
> 3) Help files published on two places On IEHS(IBM Eclipse Help system ) together with the product in Eclipse framework as the offline version
> On Wiki system as the online version.
> I think for AOO, we could create docs in the products as before and import to Wiki as well. It is essential to let the help files be accessible though the internet or google searched and getting comments directly
> The thing is we do not have to use a complex editing env or file format so that we could avoid to create the technical barrier for volunteers. Need to learn more about the Apache supported Wiki system requirement to let the editing env as simple as possible.
> Thoughts?

Here is an example of the Confluence Wiki:

https://cwiki.apache.org/confluence/display/OOOUSERS/Wiki+Home

And here is an example of our MediaWiki:

http://wiki.services.openoffice.org/wiki/Documentation/Administration_Guide/Using_Custom_Macros_and_Libraries

You can sign up for an account on both systems.

I agree with the goal of getting the documentation onto the web, so it
can be indexed by Google and count by users trying to find answers by
searching.

But I think wiki is just one option. Another would be to convert to HTML, right?

So there are a few possibilities to consider:

1) Can we make OpenOffice read and write DITA?  So use a familiar
editing tool (OpenOffice) but have it understand DITA.

Advantage:  Reuse existing Symphony content directly.  Familiar
authoring environment for documentation writers.

Disadvantage:  Would require development work to enable OpenOffice to
read/write DITA.  (But this would also be a wonderful feature for
other users as well, since DITA is an industry standard format for
technical writing)

2) Can we convert the existing Symphony documentation into ODF format,
so it can be maintained in OpenOffice?

Advantage:  We use familiar authoring environment, OpenOffice

Disadvantage: By moving away from DITA we lose some of the
capabilities to transform into other formats easily.

3) Can we support a hybrid solution where we have both DITA doc and
existing OOo doc, but unify things at publication time, by all
targeting the same output formats, like PDF and HTML

Advantage: Least amount of change required

Disadvantage: Complexity, greater difficulty in maintaining uniform
presentation styles on output

-Rob


> Betsy
> 发自我的 iPhone
>
> 在 2012-3-17,上午9:03,Rob Weir <ro...@apache.org> 写道:
>
>> On Fri, Mar 16, 2012 at 7:26 PM, Guy Waterval <wa...@gmail.com> wrote:
>>> Hello Betsy,
>>>
>>>
>>> 2012/3/16 Jing Bai <ji...@gmail.com>
>>>
>>>> Seems many people would agree that WIKI solution is a good one. Does anyone
>>>> know where we can find the WIKI hardware and platform resources in our
>>>> community? How could we setup one wiki platform for ourselves to host the
>>>> help?
>>>>
>>>
>>> Concerning this question of documentation,  I totally subscribe with the
>>> position of Jean Weber when she says :
>>>
>>> [Citation] : I also think many of the volunteers who worked on user
>>> guides for OOo -- if they choose to work on AOO docs -- prefer to work in
>>> AOO itself and produce user guides that demonstrate (some of) what one
>>> can do with the product as a publishing system. [End of citation]
>>>
>>> Moreover, I think that the choice of the wiki or the DITA format would
>>> introduce a technical barrier which would strongly reduce the number of
>>> volunteers. Please, consider that such a group as the LO fr group, which
>>> has began to translate the LO oooauthors docs, seems to have some
>>> difficulties to reach the necessary team to do the job. For me, the number
>>> of people involved does nos exceed 4 or 5. This can give you an idea of the
>>> difficulty to create a documentation team of volunteers, even when working
>>> with a well known method.
>>>
>>
>> The format isn't the issue. The issue is the editing environment,
>> right? If you could use OpenOffice as your editor and easily save it
>> to DITA, or Wiki format, then that would be OK.  Do you agree?
>>
>> If so, I think there are three questions to consider:
>>
>> 1) What editing environment(s) should we support?
>>
>> 2) What format should we use for storing the documentations in its
>> richest (fullest) form?
>>
>> 3) What publication format(s) should we publish the documentation in?
>>
>> If I understand the way the ODFAuthors are working, the choices were:
>> 1=OpenOffice, 2= ODF, 3=PDF.  Is that correct?
>>
>> Jinbai, how is it for Symphony?  1=?, 2=DITA, 3= Wiki ?
>>
>>
>> -Rob
>>
>>
>>> Of course, if the community choose another way, I will try to participate,
>>> even if I never have worked with a wiki.
>>>
>>> A+
>>>
>>> --
>>>
>>> gw

Re: Symphony documentation for AOO?

Posted by Jing Bai <ji...@gmail.com>.
Thanks all for the information.

The documentations on the MediaWiki are in good shape. The pages
are editable and logically organized containing rich contents and graphics.
There are already some topics in WIKI format. We might convert some useful
pages in the existing product help to the MediaWIKI console
programmatically.
Increasingly videos on different systems would need test. Especially on MAC
OS.

For Rob's questions:

1) Can we make OpenOffice read and write DITA?  So use a familiar editing
tool (OpenOffice) but have it understand DITA.
Advantage:  Reuse existing Symphony content directly.  Familiar authoring
environment for documentation writers.
Disadvantage:  Would require development work to enable OpenOffice to
read/write DITA.  (But this would also be a wonderful feature for
other users as well, since DITA is an industry standard format for
technical writing)
[Betsy]: If dev volunteers have enthumsiasm and bandwidth to cover that,
that would be great.

2) Can we convert the existing Symphony documentation into ODF format, so
it can be maintained in OpenOffice?
Advantage:  We use familiar authoring environment, OpenOffice Disadvantage:
By moving away from DITA we lose some of the
capabilities to transform into other formats easily.

[Betsy]: The function entries in Symphony301 are different with the AOO.
Symphony has an Eclipse framework, so if would like to use Symphony help as
a base, there would be a lot of work to make the functions entries
consistent with the C++ AOO program.  Would also need effort to investigate
how to convert DITA to ODF, the corrent IDWB would generate XHTML, PDF,
deployable DITA.

3) Can we support a hybrid solution where we have both DITA doc and
existing OOo doc, but unify things at publication time, by all
targeting the same output formats, like PDF and HTML
Advantage: Least amount of change required
Disadvantage: Complexity, greater difficulty in maintaining uniform
presentation styles on output

[Betsy]: This sounds like a plan. If the convertor can be enhanced, It
would be easy to change XHP to DITA. Writers are editing for xhp format and
can convert them to DITA later.
Also we would like to have a hybrid solution to have both WIKI help and OOo
doc. How to sync up these two format would be a question. Might need a
process on it.

On Sat, Mar 17, 2012 at 10:49 PM, Regina Henschel
<rb...@t-online.de>wrote:

> Hi all,
> Jingbai schrieb:
>
> In Symphony, 1) the editing env is a tool called ID workbench for
>> editing Dita files 2) Documentation source file format is Dita 3)
>> Help files published on two places On IEHS(IBM Eclipse Help system )
>> together with the product in Eclipse framework as the offline
>> version On Wiki system as the online version. I think for AOO, we
>> could create docs in the products as before and import to Wiki as
>> well. It is essential to let the help files be accessible though the
>> internet or google searched and getting comments directly The thing
>> is we do not have to use a complex editing env or file format so that
>> we could avoid to create the technical barrier for volunteers. Need
>> to learn more about the Apache supported Wiki system requirement to
>> let the editing env as simple as possible. Thoughts?
>>
>
> In addition to Robs links I like to show you another example to
> demonstrate the needed features to write formulas and insert graphics.
> http://wiki.services.**openoffice.org/wiki/**Documentation/How_Tos/Calc:_*
> *CHISQDIST_function<http://wiki.services.openoffice.org/wiki/Documentation/How_Tos/Calc:_CHISQDIST_function>
>
> And another point: Online guides use increasingly videos. How good are
> those supported with the different systems?
>
> Kind regards
> Regina
>
>
>

Re: Symphony documentation for AOO?

Posted by Regina Henschel <rb...@t-online.de>.
Hi all,
Jingbai schrieb:
> In Symphony, 1) the editing env is a tool called ID workbench for
> editing Dita files 2) Documentation source file format is Dita 3)
> Help files published on two places On IEHS(IBM Eclipse Help system )
> together with the product in Eclipse framework as the offline
> version On Wiki system as the online version. I think for AOO, we
> could create docs in the products as before and import to Wiki as
> well. It is essential to let the help files be accessible though the
> internet or google searched and getting comments directly The thing
> is we do not have to use a complex editing env or file format so that
> we could avoid to create the technical barrier for volunteers. Need
> to learn more about the Apache supported Wiki system requirement to
> let the editing env as simple as possible. Thoughts?

In addition to Robs links I like to show you another example to 
demonstrate the needed features to write formulas and insert graphics.
http://wiki.services.openoffice.org/wiki/Documentation/How_Tos/Calc:_CHISQDIST_function

And another point: Online guides use increasingly videos. How good are 
those supported with the different systems?

Kind regards
Regina



Re: Symphony documentation for AOO?

Posted by Jingbai <ji...@gmail.com>.
In Symphony,
1) the editing env is a tool called ID workbench for editing Dita files
2) Documentation source file format is Dita
3) Help files published on two places On IEHS(IBM Eclipse Help system ) together with the product in Eclipse framework as the offline version
On Wiki system as the online version.
I think for AOO, we could create docs in the products as before and import to Wiki as well. It is essential to let the help files be accessible though the internet or google searched and getting comments directly
The thing is we do not have to use a complex editing env or file format so that we could avoid to create the technical barrier for volunteers. Need to learn more about the Apache supported Wiki system requirement to let the editing env as simple as possible.
Thoughts?
Betsy
发自我的 iPhone

在 2012-3-17,上午9:03,Rob Weir <ro...@apache.org> 写道:

> On Fri, Mar 16, 2012 at 7:26 PM, Guy Waterval <wa...@gmail.com> wrote:
>> Hello Betsy,
>> 
>> 
>> 2012/3/16 Jing Bai <ji...@gmail.com>
>> 
>>> Seems many people would agree that WIKI solution is a good one. Does anyone
>>> know where we can find the WIKI hardware and platform resources in our
>>> community? How could we setup one wiki platform for ourselves to host the
>>> help?
>>> 
>> 
>> Concerning this question of documentation,  I totally subscribe with the
>> position of Jean Weber when she says :
>> 
>> [Citation] : I also think many of the volunteers who worked on user
>> guides for OOo -- if they choose to work on AOO docs -- prefer to work in
>> AOO itself and produce user guides that demonstrate (some of) what one
>> can do with the product as a publishing system. [End of citation]
>> 
>> Moreover, I think that the choice of the wiki or the DITA format would
>> introduce a technical barrier which would strongly reduce the number of
>> volunteers. Please, consider that such a group as the LO fr group, which
>> has began to translate the LO oooauthors docs, seems to have some
>> difficulties to reach the necessary team to do the job. For me, the number
>> of people involved does nos exceed 4 or 5. This can give you an idea of the
>> difficulty to create a documentation team of volunteers, even when working
>> with a well known method.
>> 
> 
> The format isn't the issue. The issue is the editing environment,
> right? If you could use OpenOffice as your editor and easily save it
> to DITA, or Wiki format, then that would be OK.  Do you agree?
> 
> If so, I think there are three questions to consider:
> 
> 1) What editing environment(s) should we support?
> 
> 2) What format should we use for storing the documentations in its
> richest (fullest) form?
> 
> 3) What publication format(s) should we publish the documentation in?
> 
> If I understand the way the ODFAuthors are working, the choices were:
> 1=OpenOffice, 2= ODF, 3=PDF.  Is that correct?
> 
> Jinbai, how is it for Symphony?  1=?, 2=DITA, 3= Wiki ?
> 
> 
> -Rob
> 
> 
>> Of course, if the community choose another way, I will try to participate,
>> even if I never have worked with a wiki.
>> 
>> A+
>> 
>> --
>> 
>> gw

Re: Symphony documentation for AOO?

Posted by Rob Weir <ro...@apache.org>.
On Fri, Mar 16, 2012 at 7:26 PM, Guy Waterval <wa...@gmail.com> wrote:
> Hello Betsy,
>
>
> 2012/3/16 Jing Bai <ji...@gmail.com>
>
>> Seems many people would agree that WIKI solution is a good one. Does anyone
>> know where we can find the WIKI hardware and platform resources in our
>> community? How could we setup one wiki platform for ourselves to host the
>> help?
>>
>
> Concerning this question of documentation,  I totally subscribe with the
> position of Jean Weber when she says :
>
> [Citation] : I also think many of the volunteers who worked on user
> guides for OOo -- if they choose to work on AOO docs -- prefer to work in
> AOO itself and produce user guides that demonstrate (some of) what one
> can do with the product as a publishing system. [End of citation]
>
> Moreover, I think that the choice of the wiki or the DITA format would
> introduce a technical barrier which would strongly reduce the number of
> volunteers. Please, consider that such a group as the LO fr group, which
> has began to translate the LO oooauthors docs, seems to have some
> difficulties to reach the necessary team to do the job. For me, the number
> of people involved does nos exceed 4 or 5. This can give you an idea of the
> difficulty to create a documentation team of volunteers, even when working
> with a well known method.
>

The format isn't the issue. The issue is the editing environment,
right? If you could use OpenOffice as your editor and easily save it
to DITA, or Wiki format, then that would be OK.  Do you agree?

If so, I think there are three questions to consider:

1) What editing environment(s) should we support?

2) What format should we use for storing the documentations in its
richest (fullest) form?

3) What publication format(s) should we publish the documentation in?

If I understand the way the ODFAuthors are working, the choices were:
1=OpenOffice, 2= ODF, 3=PDF.  Is that correct?

Jinbai, how is it for Symphony?  1=?, 2=DITA, 3= Wiki ?


-Rob


> Of course, if the community choose another way, I will try to participate,
> even if I never have worked with a wiki.
>
> A+
>
> --
>
> gw

Re: Symphony documentation for AOO?

Posted by Guy Waterval <wa...@gmail.com>.
Hello Betsy,


2012/3/16 Jing Bai <ji...@gmail.com>

> Seems many people would agree that WIKI solution is a good one. Does anyone
> know where we can find the WIKI hardware and platform resources in our
> community? How could we setup one wiki platform for ourselves to host the
> help?
>

Concerning this question of documentation,  I totally subscribe with the
position of Jean Weber when she says :

[Citation] : I also think many of the volunteers who worked on user
guides for OOo -- if they choose to work on AOO docs -- prefer to work in
AOO itself and produce user guides that demonstrate (some of) what one
can do with the product as a publishing system. [End of citation]

Moreover, I think that the choice of the wiki or the DITA format would
introduce a technical barrier which would strongly reduce the number of
volunteers. Please, consider that such a group as the LO fr group, which
has began to translate the LO oooauthors docs, seems to have some
difficulties to reach the necessary team to do the job. For me, the number
of people involved does nos exceed 4 or 5. This can give you an idea of the
difficulty to create a documentation team of volunteers, even when working
with a well known method.

Of course, if the community choose another way, I will try to participate,
even if I never have worked with a wiki.

A+

-- 

gw