You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doc@openoffice.apache.org by RGB ES <rg...@gmail.com> on 2013/01/18 02:31:33 UTC
Starting to build the user guide [Was Re: Possible workflow]
I started to create the User Guide pages on the wiki
http://wiki.openoffice.org/wiki/Documentation/UserGuide
Even if there is some content scattered on those pages (the UI page and
Java section under Options menu... someone needs to check my grammar) they
are mainly empty right now, but on the following days I'll try to translate
what it is already done on the ES wiki
http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
Regards
Ricardo
2013/1/15 RGB ES <rg...@gmail.com>
> 2013/1/13 Regina Henschel <rb...@t-online.de>
>
>> Hi Ricardo,
>>
>> RGB ES schrieb:
>>
>> <snip>
>>
>>
>> I propose to omit the version number level. As can be seen for ODFAuthors
>> it is unlikely, that all documents are new written for a new version and
>> sometimes it is not needed at all. LibreOffice 4.0 is in RC1, but some
>> documents are for 3.4, some for 3.5, and 3.6 is missing totally. The
>> situation becomes worse, if you think of documentations in other languages.
>>
>> I propose this way: Use a hierarchy
>> /wiki/Documentation/UserGuide/**Tips/Writer
>> or
>> /wiki/Documentation/UserGuide/**Writer/Tips
>> I'm not sure about the best order.
>>
>> If some content becomes outdated and has to be replaced, then generate a
>> new page with the same title, but a version addition.
>>
>> Example: A outdated content in the path
>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>> would be copied to a path
>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>> and the original page gets a comment line with a link to the old version
>> and the old version gets a comment line back to the newer version.
>> This has to be done by the person, who writes the new content.
>>
>> This has the advantage, that there will be no tree of empty pages, but
>> the user will always come to the most actual document, when he starts in
>> /wiki/Documentation and follows the tree.
>>
>
> Good point! I like the idea of moving outdated content to sub-pages.
>
>
>
>>
>> In the start, when not enough actual content is available, this single
>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents or
>> other suitable wiki pages.
>>
>>
>>
>>
>>> The idea is to create all the pages at once, with just the categories
>>> "Documentation" and "UserGuide" and a template similar to the one we use
>>> on
>>> the ES wiki(2) for "work in process new pages", that we can call "Draft"
>>> (not sure if there is one already: I cannot find it).
>>>
>>
>> Creating a new "UserGuide" section is OK, but same other sections need to
>> be there from the beginning too. I think of pathes to the developers guide,
>> to the building guide, to the QA tutorials, to the Calc functions reference.
>
>
> Sure. We can update the main documentation page(1) to gather all those
> elements on one place.
>
> (1) http://wiki.openoffice.org/wiki/Documentation
>
>
>
>>
>>
>>
>>> In parallel, we can start discussing about writing style, screenshots
>>> (desktop theme...) and related problems on other topics.
>>>
>>
>> There is the page http://wiki.openoffice.org/**
>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy>.
>> It is already fairly good, and can be used as start. Adaption to AOO is of
>> cause needed.
>
>
> Thanks for the link! Looking there I see that the DraftPage template is
> already present: {{Documentation/DraftPage}}
>
>
>
>>
>>
>>
>>> After "seeding" some pages with content we start a call for authors and
>>> the
>>> "real writing"(3). Finally, when the author is ready he/she calls for
>>> review/proof reading and when every is OK we delete the "Draft" template.
>>>
>>> What do you think?
>>>
>>
>> I fear, a lot a pages will stay "draft" for ever.
>>
>> What are your plans about the old Dokumentation hierarchy ?
>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>> of_the_Wiki<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki>
>
>
>
> No plans, for the moment. I just tried to start the discussion for a self
> contained 4.0 user guide written from scratch and easy to maintain.
>
> The structure of the Documentation section on the wiki is indeed quite
> complex and it is difficult for a new user to tell apart what's still
> valid. Maybe we need to make a completely fresh start here, moving old
> content to a "legacy" section... but on the other hand we cannot left the
> site empty.
>
> Regards
> Ricardo
>
>
>
>>
>>
>> Kind regards
>> Regina
>>
>>
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
2013/2/7 Andrea Pescetti <pe...@apache.org>
> On 31/01/2013 02:03, RGB ES wrote:
>
>> The first draft for a Writer guide is now (almost) complete
>> http://wiki.openoffice.org/**wiki/Documentation/UserGuide/**Writer<http://wiki.openoffice.org/wiki/Documentation/UserGuide/Writer>
>>
>
> Very nice, Ricardo! I had a look and it is already quite complete. I fixed
> a few typos, but of course it will need to be reviewed by a native English
> speaker.
>
> I'm sorry that you are now forced to take a break due to personal issues.
> Looking forward to seeing you back to normal activity soon!
>
Thanks! I'll try to come back ASAP.
Regards
Ricardo
>
> Regards,
> Andrea.
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by Andrea Pescetti <pe...@apache.org>.
On 31/01/2013 02:03, RGB ES wrote:
> The first draft for a Writer guide is now (almost) complete
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Writer
Very nice, Ricardo! I had a look and it is already quite complete. I
fixed a few typos, but of course it will need to be reviewed by a native
English speaker.
I'm sorry that you are now forced to take a break due to personal
issues. Looking forward to seeing you back to normal activity soon!
Regards,
Andrea.
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
2013/1/21 RGB ES <rg...@gmail.com>
>
>>
> I'll try to build a first draft of the Writer guide this week,
>
The first draft for a Writer guide is now (almost) complete
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Writer
Grammar checkers are needed... :)
There are a couple of holes on those pages, volunteers to fill them and
expand the rest are welcome.
I'll try on the next weeks to write about Math.
Regards
Ricardo
> but yes, we can start thinking on a call for volunteers. But there are
> still several open discussions that maybe it is better to close first:
> mainly writing style and workflow (screenshots consistency is important
> too, but pictures are easy to update)
>
> Regards
> Ricardo
>
>
>
>>
>> -Rob
>>
>>
>> > Regards
>> > Ricardo
>> >
>> >
>> >
>> >> Even if there is some content scattered on those pages (the UI page and
>> >> Java section under Options menu... someone needs to check my grammar)
>> they
>> >> are mainly empty right now, but on the following days I'll try to
>> translate
>> >> what it is already done on the ES wiki
>> >>
>> >> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
>> >>
>> >> Regards
>> >> Ricardo
>> >>
>> >>
>> >>
>> >> 2013/1/15 RGB ES <rg...@gmail.com>
>> >>
>> >>> 2013/1/13 Regina Henschel <rb...@t-online.de>
>> >>>
>> >>>> Hi Ricardo,
>> >>>>
>> >>>> RGB ES schrieb:
>> >>>>
>> >>>> <snip>
>> >>>>
>> >>>>
>> >>>> I propose to omit the version number level. As can be seen for
>> >>>> ODFAuthors it is unlikely, that all documents are new written for a
>> new
>> >>>> version and sometimes it is not needed at all. LibreOffice 4.0 is in
>> RC1,
>> >>>> but some documents are for 3.4, some for 3.5, and 3.6 is missing
>> totally.
>> >>>> The situation becomes worse, if you think of documentations in other
>> >>>> languages.
>> >>>>
>> >>>> I propose this way: Use a hierarchy
>> >>>> /wiki/Documentation/UserGuide/**Tips/Writer
>> >>>> or
>> >>>> /wiki/Documentation/UserGuide/**Writer/Tips
>> >>>> I'm not sure about the best order.
>> >>>>
>> >>>> If some content becomes outdated and has to be replaced, then
>> generate a
>> >>>> new page with the same title, but a version addition.
>> >>>>
>> >>>> Example: A outdated content in the path
>> >>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>> >>>> would be copied to a path
>> >>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>> >>>> and the original page gets a comment line with a link to the old
>> version
>> >>>> and the old version gets a comment line back to the newer version.
>> >>>> This has to be done by the person, who writes the new content.
>> >>>>
>> >>>> This has the advantage, that there will be no tree of empty pages,
>> but
>> >>>> the user will always come to the most actual document, when he
>> starts in
>> >>>> /wiki/Documentation and follows the tree.
>> >>>>
>> >>>
>> >>> Good point! I like the idea of moving outdated content to sub-pages.
>> >>>
>> >>>
>> >>>
>> >>>>
>> >>>> In the start, when not enough actual content is available, this
>> single
>> >>>> comment line can link to the existing ODFAuthors 3.3 or 3.2
>> documents or
>> >>>> other suitable wiki pages.
>> >>>>
>> >>>>
>> >>>>
>> >>>>
>> >>>>> The idea is to create all the pages at once, with just the
>> categories
>> >>>>> "Documentation" and "UserGuide" and a template similar to the one we
>> >>>>> use on
>> >>>>> the ES wiki(2) for "work in process new pages", that we can call
>> "Draft"
>> >>>>> (not sure if there is one already: I cannot find it).
>> >>>>>
>> >>>>
>> >>>> Creating a new "UserGuide" section is OK, but same other sections
>> need
>> >>>> to be there from the beginning too. I think of pathes to the
>> developers
>> >>>> guide, to the building guide, to the QA tutorials, to the Calc
>> functions
>> >>>> reference.
>> >>>
>> >>>
>> >>> Sure. We can update the main documentation page(1) to gather all those
>> >>> elements on one place.
>> >>>
>> >>> (1) http://wiki.openoffice.org/wiki/Documentation
>> >>>
>> >>>
>> >>>
>> >>>>
>> >>>>
>> >>>>
>> >>>>> In parallel, we can start discussing about writing style,
>> screenshots
>> >>>>> (desktop theme...) and related problems on other topics.
>> >>>>>
>> >>>>
>> >>>> There is the page http://wiki.openoffice.org/**
>> >>>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<
>> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy
>> >.
>> >>>> It is already fairly good, and can be used as start. Adaption to AOO
>> is of
>> >>>> cause needed.
>> >>>
>> >>>
>> >>> Thanks for the link! Looking there I see that the DraftPage template
>> is
>> >>> already present: {{Documentation/DraftPage}}
>> >>>
>> >>>
>> >>>
>> >>>>
>> >>>>
>> >>>>
>> >>>>> After "seeding" some pages with content we start a call for authors
>> and
>> >>>>> the
>> >>>>> "real writing"(3). Finally, when the author is ready he/she calls
>> for
>> >>>>> review/proof reading and when every is OK we delete the "Draft"
>> >>>>> template.
>> >>>>>
>> >>>>> What do you think?
>> >>>>>
>> >>>>
>> >>>> I fear, a lot a pages will stay "draft" for ever.
>> >>>>
>> >>>> What are your plans about the old Dokumentation hierarchy ?
>> >>>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>> >>>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>> >>>> of_the_Wiki<
>> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki
>> >
>> >>>
>> >>>
>> >>>
>> >>> No plans, for the moment. I just tried to start the discussion for a
>> self
>> >>> contained 4.0 user guide written from scratch and easy to maintain.
>> >>>
>> >>> The structure of the Documentation section on the wiki is indeed quite
>> >>> complex and it is difficult for a new user to tell apart what's still
>> >>> valid. Maybe we need to make a completely fresh start here, moving old
>> >>> content to a "legacy" section... but on the other hand we cannot left
>> the
>> >>> site empty.
>> >>>
>> >>> Regards
>> >>> Ricardo
>> >>>
>> >>>
>> >>>
>> >>>>
>> >>>>
>> >>>> Kind regards
>> >>>> Regina
>> >>>>
>> >>>>
>> >>>
>> >>
>>
>
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
2013/1/21 Rob Weir <ro...@apache.org>
> On Sun, Jan 20, 2013 at 10:08 AM, RGB ES <rg...@gmail.com> wrote:
> > 2013/1/18 RGB ES <rg...@gmail.com>
> >
> >> I started to create the User Guide pages on the wiki
> >>
> >> http://wiki.openoffice.org/wiki/Documentation/UserGuide
> >>
> >>
> >
> > I need some help here. There are now several pages covering the beginning
> > of the guide
> >
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
> > and the sub page
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
> >
> > All these pages needs proofreading (as you can see, English is not my
> > native language) and someone that fill their holes.
> >
> > The page about supported file formats is completely empty and needs an
> > author
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
> >
> > I think a general spellcheck guide is also needed, but not sure where to
> > put it on the "tree". Maybe below Formatting and before SearchReplace?
> >
> > Also, install guides are needed, maybe at the beginning of the guide? I
> > wrote a Linux install guide on the forums that can be "wikified":
> >
> > http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
> >
> > In the near future I can start with the Writer and Math guides, but
> someone
> > needs to take care of other components.
> >
> > Thoughts? Volunteers? ;)
> >
>
> Do we want to have a "call for volunteers" soon? Or do you want to
> make more progress first?
>
I'll try to build a first draft of the Writer guide this week, but yes, we
can start thinking on a call for volunteers. But there are still several
open discussions that maybe it is better to close first: mainly writing
style and workflow (screenshots consistency is important too, but pictures
are easy to update)
Regards
Ricardo
>
> -Rob
>
>
> > Regards
> > Ricardo
> >
> >
> >
> >> Even if there is some content scattered on those pages (the UI page and
> >> Java section under Options menu... someone needs to check my grammar)
> they
> >> are mainly empty right now, but on the following days I'll try to
> translate
> >> what it is already done on the ES wiki
> >>
> >> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
> >>
> >> Regards
> >> Ricardo
> >>
> >>
> >>
> >> 2013/1/15 RGB ES <rg...@gmail.com>
> >>
> >>> 2013/1/13 Regina Henschel <rb...@t-online.de>
> >>>
> >>>> Hi Ricardo,
> >>>>
> >>>> RGB ES schrieb:
> >>>>
> >>>> <snip>
> >>>>
> >>>>
> >>>> I propose to omit the version number level. As can be seen for
> >>>> ODFAuthors it is unlikely, that all documents are new written for a
> new
> >>>> version and sometimes it is not needed at all. LibreOffice 4.0 is in
> RC1,
> >>>> but some documents are for 3.4, some for 3.5, and 3.6 is missing
> totally.
> >>>> The situation becomes worse, if you think of documentations in other
> >>>> languages.
> >>>>
> >>>> I propose this way: Use a hierarchy
> >>>> /wiki/Documentation/UserGuide/**Tips/Writer
> >>>> or
> >>>> /wiki/Documentation/UserGuide/**Writer/Tips
> >>>> I'm not sure about the best order.
> >>>>
> >>>> If some content becomes outdated and has to be replaced, then
> generate a
> >>>> new page with the same title, but a version addition.
> >>>>
> >>>> Example: A outdated content in the path
> >>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
> >>>> would be copied to a path
> >>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
> >>>> and the original page gets a comment line with a link to the old
> version
> >>>> and the old version gets a comment line back to the newer version.
> >>>> This has to be done by the person, who writes the new content.
> >>>>
> >>>> This has the advantage, that there will be no tree of empty pages, but
> >>>> the user will always come to the most actual document, when he starts
> in
> >>>> /wiki/Documentation and follows the tree.
> >>>>
> >>>
> >>> Good point! I like the idea of moving outdated content to sub-pages.
> >>>
> >>>
> >>>
> >>>>
> >>>> In the start, when not enough actual content is available, this single
> >>>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents
> or
> >>>> other suitable wiki pages.
> >>>>
> >>>>
> >>>>
> >>>>
> >>>>> The idea is to create all the pages at once, with just the categories
> >>>>> "Documentation" and "UserGuide" and a template similar to the one we
> >>>>> use on
> >>>>> the ES wiki(2) for "work in process new pages", that we can call
> "Draft"
> >>>>> (not sure if there is one already: I cannot find it).
> >>>>>
> >>>>
> >>>> Creating a new "UserGuide" section is OK, but same other sections need
> >>>> to be there from the beginning too. I think of pathes to the
> developers
> >>>> guide, to the building guide, to the QA tutorials, to the Calc
> functions
> >>>> reference.
> >>>
> >>>
> >>> Sure. We can update the main documentation page(1) to gather all those
> >>> elements on one place.
> >>>
> >>> (1) http://wiki.openoffice.org/wiki/Documentation
> >>>
> >>>
> >>>
> >>>>
> >>>>
> >>>>
> >>>>> In parallel, we can start discussing about writing style, screenshots
> >>>>> (desktop theme...) and related problems on other topics.
> >>>>>
> >>>>
> >>>> There is the page http://wiki.openoffice.org/**
> >>>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy
> >.
> >>>> It is already fairly good, and can be used as start. Adaption to AOO
> is of
> >>>> cause needed.
> >>>
> >>>
> >>> Thanks for the link! Looking there I see that the DraftPage template is
> >>> already present: {{Documentation/DraftPage}}
> >>>
> >>>
> >>>
> >>>>
> >>>>
> >>>>
> >>>>> After "seeding" some pages with content we start a call for authors
> and
> >>>>> the
> >>>>> "real writing"(3). Finally, when the author is ready he/she calls for
> >>>>> review/proof reading and when every is OK we delete the "Draft"
> >>>>> template.
> >>>>>
> >>>>> What do you think?
> >>>>>
> >>>>
> >>>> I fear, a lot a pages will stay "draft" for ever.
> >>>>
> >>>> What are your plans about the old Dokumentation hierarchy ?
> >>>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
> >>>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
> >>>> of_the_Wiki<
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki
> >
> >>>
> >>>
> >>>
> >>> No plans, for the moment. I just tried to start the discussion for a
> self
> >>> contained 4.0 user guide written from scratch and easy to maintain.
> >>>
> >>> The structure of the Documentation section on the wiki is indeed quite
> >>> complex and it is difficult for a new user to tell apart what's still
> >>> valid. Maybe we need to make a completely fresh start here, moving old
> >>> content to a "legacy" section... but on the other hand we cannot left
> the
> >>> site empty.
> >>>
> >>> Regards
> >>> Ricardo
> >>>
> >>>
> >>>
> >>>>
> >>>>
> >>>> Kind regards
> >>>> Regina
> >>>>
> >>>>
> >>>
> >>
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by Rob Weir <ro...@apache.org>.
On Sun, Jan 20, 2013 at 10:08 AM, RGB ES <rg...@gmail.com> wrote:
> 2013/1/18 RGB ES <rg...@gmail.com>
>
>> I started to create the User Guide pages on the wiki
>>
>> http://wiki.openoffice.org/wiki/Documentation/UserGuide
>>
>>
>
> I need some help here. There are now several pages covering the beginning
> of the guide
>
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
> and the sub page
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
>
> All these pages needs proofreading (as you can see, English is not my
> native language) and someone that fill their holes.
>
> The page about supported file formats is completely empty and needs an
> author
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
>
> I think a general spellcheck guide is also needed, but not sure where to
> put it on the "tree". Maybe below Formatting and before SearchReplace?
>
> Also, install guides are needed, maybe at the beginning of the guide? I
> wrote a Linux install guide on the forums that can be "wikified":
>
> http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
>
> In the near future I can start with the Writer and Math guides, but someone
> needs to take care of other components.
>
> Thoughts? Volunteers? ;)
>
Do we want to have a "call for volunteers" soon? Or do you want to
make more progress first?
-Rob
> Regards
> Ricardo
>
>
>
>> Even if there is some content scattered on those pages (the UI page and
>> Java section under Options menu... someone needs to check my grammar) they
>> are mainly empty right now, but on the following days I'll try to translate
>> what it is already done on the ES wiki
>>
>> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
>>
>> Regards
>> Ricardo
>>
>>
>>
>> 2013/1/15 RGB ES <rg...@gmail.com>
>>
>>> 2013/1/13 Regina Henschel <rb...@t-online.de>
>>>
>>>> Hi Ricardo,
>>>>
>>>> RGB ES schrieb:
>>>>
>>>> <snip>
>>>>
>>>>
>>>> I propose to omit the version number level. As can be seen for
>>>> ODFAuthors it is unlikely, that all documents are new written for a new
>>>> version and sometimes it is not needed at all. LibreOffice 4.0 is in RC1,
>>>> but some documents are for 3.4, some for 3.5, and 3.6 is missing totally.
>>>> The situation becomes worse, if you think of documentations in other
>>>> languages.
>>>>
>>>> I propose this way: Use a hierarchy
>>>> /wiki/Documentation/UserGuide/**Tips/Writer
>>>> or
>>>> /wiki/Documentation/UserGuide/**Writer/Tips
>>>> I'm not sure about the best order.
>>>>
>>>> If some content becomes outdated and has to be replaced, then generate a
>>>> new page with the same title, but a version addition.
>>>>
>>>> Example: A outdated content in the path
>>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>>>> would be copied to a path
>>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>>>> and the original page gets a comment line with a link to the old version
>>>> and the old version gets a comment line back to the newer version.
>>>> This has to be done by the person, who writes the new content.
>>>>
>>>> This has the advantage, that there will be no tree of empty pages, but
>>>> the user will always come to the most actual document, when he starts in
>>>> /wiki/Documentation and follows the tree.
>>>>
>>>
>>> Good point! I like the idea of moving outdated content to sub-pages.
>>>
>>>
>>>
>>>>
>>>> In the start, when not enough actual content is available, this single
>>>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents or
>>>> other suitable wiki pages.
>>>>
>>>>
>>>>
>>>>
>>>>> The idea is to create all the pages at once, with just the categories
>>>>> "Documentation" and "UserGuide" and a template similar to the one we
>>>>> use on
>>>>> the ES wiki(2) for "work in process new pages", that we can call "Draft"
>>>>> (not sure if there is one already: I cannot find it).
>>>>>
>>>>
>>>> Creating a new "UserGuide" section is OK, but same other sections need
>>>> to be there from the beginning too. I think of pathes to the developers
>>>> guide, to the building guide, to the QA tutorials, to the Calc functions
>>>> reference.
>>>
>>>
>>> Sure. We can update the main documentation page(1) to gather all those
>>> elements on one place.
>>>
>>> (1) http://wiki.openoffice.org/wiki/Documentation
>>>
>>>
>>>
>>>>
>>>>
>>>>
>>>>> In parallel, we can start discussing about writing style, screenshots
>>>>> (desktop theme...) and related problems on other topics.
>>>>>
>>>>
>>>> There is the page http://wiki.openoffice.org/**
>>>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy>.
>>>> It is already fairly good, and can be used as start. Adaption to AOO is of
>>>> cause needed.
>>>
>>>
>>> Thanks for the link! Looking there I see that the DraftPage template is
>>> already present: {{Documentation/DraftPage}}
>>>
>>>
>>>
>>>>
>>>>
>>>>
>>>>> After "seeding" some pages with content we start a call for authors and
>>>>> the
>>>>> "real writing"(3). Finally, when the author is ready he/she calls for
>>>>> review/proof reading and when every is OK we delete the "Draft"
>>>>> template.
>>>>>
>>>>> What do you think?
>>>>>
>>>>
>>>> I fear, a lot a pages will stay "draft" for ever.
>>>>
>>>> What are your plans about the old Dokumentation hierarchy ?
>>>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>>>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>>>> of_the_Wiki<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki>
>>>
>>>
>>>
>>> No plans, for the moment. I just tried to start the discussion for a self
>>> contained 4.0 user guide written from scratch and easy to maintain.
>>>
>>> The structure of the Documentation section on the wiki is indeed quite
>>> complex and it is difficult for a new user to tell apart what's still
>>> valid. Maybe we need to make a completely fresh start here, moving old
>>> content to a "legacy" section... but on the other hand we cannot left the
>>> site empty.
>>>
>>> Regards
>>> Ricardo
>>>
>>>
>>>
>>>>
>>>>
>>>> Kind regards
>>>> Regina
>>>>
>>>>
>>>
>>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
2013/1/22 RGB ES <rg...@gmail.com>
> Hello, Bonnie!
>
>
> 2013/1/22 Bonnie Smith Ries <ri...@gmail.com>
>
>> I'd love to work on this; I am a brand-new volunteer, though, and don't
>> know how to download the documentation. Any help would be appreciated!
>>
>
> Right now, the documentation is growing on the wiki, so it is online only:
> you need an account to edit the documents. I think there is an extension
> for Writer to export on wiki format but I've never used it.
>
> As you know Spanish, you can help me to translate the pages existing on
> the ES wiki. I'll create the pages on the EN wiki to fill them.
>
There is now a 1 to 1 correspondence between the pages listed here (on
Spanish)
http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO/Writer
and the pages listed here
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Writer
with the small difference that for now most of the pages on the second list
are almost empty, waiting for someone to fill them :)
Ricardo
>
> Regards
> Ricardo
>
>
>
>>
>> Me gustaría mucho trabajar en este proyecto; soy voluntaria nueva, y no sé
>> descargar los documentos. ¡Agradecería de cualquiera ayuda!
>>
>> Español no es mi idioma primero, pero puedo escribirlo tolerablemente.
>>
>> Bonnie Smith Ries
>>
>> On Sun, Jan 20, 2013 at 8:08 AM, RGB ES <rg...@gmail.com> wrote:
>>
>> > 2013/1/18 RGB ES <rg...@gmail.com>
>> >
>> > > I started to create the User Guide pages on the wiki
>> > >
>> > > http://wiki.openoffice.org/wiki/Documentation/UserGuide
>> > >
>> > >
>> >
>> > I need some help here. There are now several pages covering the
>> beginning
>> > of the guide
>> >
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
>> > and the sub page
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
>> >
>> > All these pages needs proofreading (as you can see, English is not my
>> > native language) and someone that fill their holes.
>> >
>> > The page about supported file formats is completely empty and needs an
>> > author
>> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
>> >
>> > I think a general spellcheck guide is also needed, but not sure where to
>> > put it on the "tree". Maybe below Formatting and before SearchReplace?
>> >
>> > Also, install guides are needed, maybe at the beginning of the guide? I
>> > wrote a Linux install guide on the forums that can be "wikified":
>> >
>> > http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
>> >
>> > In the near future I can start with the Writer and Math guides, but
>> someone
>> > needs to take care of other components.
>> >
>> > Thoughts? Volunteers? ;)
>> >
>> > Regards
>> > Ricardo
>> >
>> >
>> >
>> > > Even if there is some content scattered on those pages (the UI page
>> and
>> > > Java section under Options menu... someone needs to check my grammar)
>> > they
>> > > are mainly empty right now, but on the following days I'll try to
>> > translate
>> > > what it is already done on the ES wiki
>> > >
>> > > http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
>> > >
>> > > Regards
>> > > Ricardo
>> > >
>> > >
>> > >
>> > > 2013/1/15 RGB ES <rg...@gmail.com>
>> > >
>> > >> 2013/1/13 Regina Henschel <rb...@t-online.de>
>> > >>
>> > >>> Hi Ricardo,
>> > >>>
>> > >>> RGB ES schrieb:
>> > >>>
>> > >>> <snip>
>> > >>>
>> > >>>
>> > >>> I propose to omit the version number level. As can be seen for
>> > >>> ODFAuthors it is unlikely, that all documents are new written for a
>> new
>> > >>> version and sometimes it is not needed at all. LibreOffice 4.0 is in
>> > RC1,
>> > >>> but some documents are for 3.4, some for 3.5, and 3.6 is missing
>> > totally.
>> > >>> The situation becomes worse, if you think of documentations in other
>> > >>> languages.
>> > >>>
>> > >>> I propose this way: Use a hierarchy
>> > >>> /wiki/Documentation/UserGuide/**Tips/Writer
>> > >>> or
>> > >>> /wiki/Documentation/UserGuide/**Writer/Tips
>> > >>> I'm not sure about the best order.
>> > >>>
>> > >>> If some content becomes outdated and has to be replaced, then
>> generate
>> > a
>> > >>> new page with the same title, but a version addition.
>> > >>>
>> > >>> Example: A outdated content in the path
>> > >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>> > >>> would be copied to a path
>> > >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>> > >>> and the original page gets a comment line with a link to the old
>> > version
>> > >>> and the old version gets a comment line back to the newer version.
>> > >>> This has to be done by the person, who writes the new content.
>> > >>>
>> > >>> This has the advantage, that there will be no tree of empty pages,
>> but
>> > >>> the user will always come to the most actual document, when he
>> starts
>> > in
>> > >>> /wiki/Documentation and follows the tree.
>> > >>>
>> > >>
>> > >> Good point! I like the idea of moving outdated content to sub-pages.
>> > >>
>> > >>
>> > >>
>> > >>>
>> > >>> In the start, when not enough actual content is available, this
>> single
>> > >>> comment line can link to the existing ODFAuthors 3.3 or 3.2
>> documents
>> > or
>> > >>> other suitable wiki pages.
>> > >>>
>> > >>>
>> > >>>
>> > >>>
>> > >>>> The idea is to create all the pages at once, with just the
>> categories
>> > >>>> "Documentation" and "UserGuide" and a template similar to the one
>> we
>> > >>>> use on
>> > >>>> the ES wiki(2) for "work in process new pages", that we can call
>> > "Draft"
>> > >>>> (not sure if there is one already: I cannot find it).
>> > >>>>
>> > >>>
>> > >>> Creating a new "UserGuide" section is OK, but same other sections
>> need
>> > >>> to be there from the beginning too. I think of pathes to the
>> developers
>> > >>> guide, to the building guide, to the QA tutorials, to the Calc
>> > functions
>> > >>> reference.
>> > >>
>> > >>
>> > >> Sure. We can update the main documentation page(1) to gather all
>> those
>> > >> elements on one place.
>> > >>
>> > >> (1) http://wiki.openoffice.org/wiki/Documentation
>> > >>
>> > >>
>> > >>
>> > >>>
>> > >>>
>> > >>>
>> > >>>> In parallel, we can start discussing about writing style,
>> screenshots
>> > >>>> (desktop theme...) and related problems on other topics.
>> > >>>>
>> > >>>
>> > >>> There is the page http://wiki.openoffice.org/**
>> > >>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<
>> >
>> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy
>> > >.
>> > >>> It is already fairly good, and can be used as start. Adaption to AOO
>> > is of
>> > >>> cause needed.
>> > >>
>> > >>
>> > >> Thanks for the link! Looking there I see that the DraftPage template
>> is
>> > >> already present: {{Documentation/DraftPage}}
>> > >>
>> > >>
>> > >>
>> > >>>
>> > >>>
>> > >>>
>> > >>>> After "seeding" some pages with content we start a call for authors
>> > and
>> > >>>> the
>> > >>>> "real writing"(3). Finally, when the author is ready he/she calls
>> for
>> > >>>> review/proof reading and when every is OK we delete the "Draft"
>> > >>>> template.
>> > >>>>
>> > >>>> What do you think?
>> > >>>>
>> > >>>
>> > >>> I fear, a lot a pages will stay "draft" for ever.
>> > >>>
>> > >>> What are your plans about the old Dokumentation hierarchy ?
>> > >>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>> > >>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>> > >>> of_the_Wiki<
>> >
>> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki
>> > >
>> > >>
>> > >>
>> > >>
>> > >> No plans, for the moment. I just tried to start the discussion for a
>> > self
>> > >> contained 4.0 user guide written from scratch and easy to maintain.
>> > >>
>> > >> The structure of the Documentation section on the wiki is indeed
>> quite
>> > >> complex and it is difficult for a new user to tell apart what's still
>> > >> valid. Maybe we need to make a completely fresh start here, moving
>> old
>> > >> content to a "legacy" section... but on the other hand we cannot left
>> > the
>> > >> site empty.
>> > >>
>> > >> Regards
>> > >> Ricardo
>> > >>
>> > >>
>> > >>
>> > >>>
>> > >>>
>> > >>> Kind regards
>> > >>> Regina
>> > >>>
>> > >>>
>> > >>
>> > >
>> >
>>
>>
>>
>> --
>> XOXOXOXO
>> Bonnie Smith Ries
>>
>
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
Hello, Bonnie!
2013/1/22 Bonnie Smith Ries <ri...@gmail.com>
> I'd love to work on this; I am a brand-new volunteer, though, and don't
> know how to download the documentation. Any help would be appreciated!
>
Right now, the documentation is growing on the wiki, so it is online only:
you need an account to edit the documents. I think there is an extension
for Writer to export on wiki format but I've never used it.
As you know Spanish, you can help me to translate the pages existing on the
ES wiki. I'll create the pages on the EN wiki to fill them.
Regards
Ricardo
>
> Me gustaría mucho trabajar en este proyecto; soy voluntaria nueva, y no sé
> descargar los documentos. ¡Agradecería de cualquiera ayuda!
>
> Español no es mi idioma primero, pero puedo escribirlo tolerablemente.
>
> Bonnie Smith Ries
>
> On Sun, Jan 20, 2013 at 8:08 AM, RGB ES <rg...@gmail.com> wrote:
>
> > 2013/1/18 RGB ES <rg...@gmail.com>
> >
> > > I started to create the User Guide pages on the wiki
> > >
> > > http://wiki.openoffice.org/wiki/Documentation/UserGuide
> > >
> > >
> >
> > I need some help here. There are now several pages covering the beginning
> > of the guide
> >
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
> > and the sub page
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
> >
> > All these pages needs proofreading (as you can see, English is not my
> > native language) and someone that fill their holes.
> >
> > The page about supported file formats is completely empty and needs an
> > author
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
> >
> > I think a general spellcheck guide is also needed, but not sure where to
> > put it on the "tree". Maybe below Formatting and before SearchReplace?
> >
> > Also, install guides are needed, maybe at the beginning of the guide? I
> > wrote a Linux install guide on the forums that can be "wikified":
> >
> > http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
> >
> > In the near future I can start with the Writer and Math guides, but
> someone
> > needs to take care of other components.
> >
> > Thoughts? Volunteers? ;)
> >
> > Regards
> > Ricardo
> >
> >
> >
> > > Even if there is some content scattered on those pages (the UI page and
> > > Java section under Options menu... someone needs to check my grammar)
> > they
> > > are mainly empty right now, but on the following days I'll try to
> > translate
> > > what it is already done on the ES wiki
> > >
> > > http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
> > >
> > > Regards
> > > Ricardo
> > >
> > >
> > >
> > > 2013/1/15 RGB ES <rg...@gmail.com>
> > >
> > >> 2013/1/13 Regina Henschel <rb...@t-online.de>
> > >>
> > >>> Hi Ricardo,
> > >>>
> > >>> RGB ES schrieb:
> > >>>
> > >>> <snip>
> > >>>
> > >>>
> > >>> I propose to omit the version number level. As can be seen for
> > >>> ODFAuthors it is unlikely, that all documents are new written for a
> new
> > >>> version and sometimes it is not needed at all. LibreOffice 4.0 is in
> > RC1,
> > >>> but some documents are for 3.4, some for 3.5, and 3.6 is missing
> > totally.
> > >>> The situation becomes worse, if you think of documentations in other
> > >>> languages.
> > >>>
> > >>> I propose this way: Use a hierarchy
> > >>> /wiki/Documentation/UserGuide/**Tips/Writer
> > >>> or
> > >>> /wiki/Documentation/UserGuide/**Writer/Tips
> > >>> I'm not sure about the best order.
> > >>>
> > >>> If some content becomes outdated and has to be replaced, then
> generate
> > a
> > >>> new page with the same title, but a version addition.
> > >>>
> > >>> Example: A outdated content in the path
> > >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
> > >>> would be copied to a path
> > >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
> > >>> and the original page gets a comment line with a link to the old
> > version
> > >>> and the old version gets a comment line back to the newer version.
> > >>> This has to be done by the person, who writes the new content.
> > >>>
> > >>> This has the advantage, that there will be no tree of empty pages,
> but
> > >>> the user will always come to the most actual document, when he starts
> > in
> > >>> /wiki/Documentation and follows the tree.
> > >>>
> > >>
> > >> Good point! I like the idea of moving outdated content to sub-pages.
> > >>
> > >>
> > >>
> > >>>
> > >>> In the start, when not enough actual content is available, this
> single
> > >>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents
> > or
> > >>> other suitable wiki pages.
> > >>>
> > >>>
> > >>>
> > >>>
> > >>>> The idea is to create all the pages at once, with just the
> categories
> > >>>> "Documentation" and "UserGuide" and a template similar to the one we
> > >>>> use on
> > >>>> the ES wiki(2) for "work in process new pages", that we can call
> > "Draft"
> > >>>> (not sure if there is one already: I cannot find it).
> > >>>>
> > >>>
> > >>> Creating a new "UserGuide" section is OK, but same other sections
> need
> > >>> to be there from the beginning too. I think of pathes to the
> developers
> > >>> guide, to the building guide, to the QA tutorials, to the Calc
> > functions
> > >>> reference.
> > >>
> > >>
> > >> Sure. We can update the main documentation page(1) to gather all those
> > >> elements on one place.
> > >>
> > >> (1) http://wiki.openoffice.org/wiki/Documentation
> > >>
> > >>
> > >>
> > >>>
> > >>>
> > >>>
> > >>>> In parallel, we can start discussing about writing style,
> screenshots
> > >>>> (desktop theme...) and related problems on other topics.
> > >>>>
> > >>>
> > >>> There is the page http://wiki.openoffice.org/**
> > >>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<
> >
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy
> > >.
> > >>> It is already fairly good, and can be used as start. Adaption to AOO
> > is of
> > >>> cause needed.
> > >>
> > >>
> > >> Thanks for the link! Looking there I see that the DraftPage template
> is
> > >> already present: {{Documentation/DraftPage}}
> > >>
> > >>
> > >>
> > >>>
> > >>>
> > >>>
> > >>>> After "seeding" some pages with content we start a call for authors
> > and
> > >>>> the
> > >>>> "real writing"(3). Finally, when the author is ready he/she calls
> for
> > >>>> review/proof reading and when every is OK we delete the "Draft"
> > >>>> template.
> > >>>>
> > >>>> What do you think?
> > >>>>
> > >>>
> > >>> I fear, a lot a pages will stay "draft" for ever.
> > >>>
> > >>> What are your plans about the old Dokumentation hierarchy ?
> > >>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
> > >>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
> > >>> of_the_Wiki<
> >
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki
> > >
> > >>
> > >>
> > >>
> > >> No plans, for the moment. I just tried to start the discussion for a
> > self
> > >> contained 4.0 user guide written from scratch and easy to maintain.
> > >>
> > >> The structure of the Documentation section on the wiki is indeed quite
> > >> complex and it is difficult for a new user to tell apart what's still
> > >> valid. Maybe we need to make a completely fresh start here, moving old
> > >> content to a "legacy" section... but on the other hand we cannot left
> > the
> > >> site empty.
> > >>
> > >> Regards
> > >> Ricardo
> > >>
> > >>
> > >>
> > >>>
> > >>>
> > >>> Kind regards
> > >>> Regina
> > >>>
> > >>>
> > >>
> > >
> >
>
>
>
> --
> XOXOXOXO
> Bonnie Smith Ries
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by Bonnie Smith Ries <ri...@gmail.com>.
I'd love to work on this; I am a brand-new volunteer, though, and don't
know how to download the documentation. Any help would be appreciated!
Me gustaría mucho trabajar en este proyecto; soy voluntaria nueva, y no sé
descargar los documentos. ¡Agradecería de cualquiera ayuda!
Español no es mi idioma primero, pero puedo escribirlo tolerablemente.
Bonnie Smith Ries
On Sun, Jan 20, 2013 at 8:08 AM, RGB ES <rg...@gmail.com> wrote:
> 2013/1/18 RGB ES <rg...@gmail.com>
>
> > I started to create the User Guide pages on the wiki
> >
> > http://wiki.openoffice.org/wiki/Documentation/UserGuide
> >
> >
>
> I need some help here. There are now several pages covering the beginning
> of the guide
>
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
> and the sub page
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
>
> All these pages needs proofreading (as you can see, English is not my
> native language) and someone that fill their holes.
>
> The page about supported file formats is completely empty and needs an
> author
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
>
> I think a general spellcheck guide is also needed, but not sure where to
> put it on the "tree". Maybe below Formatting and before SearchReplace?
>
> Also, install guides are needed, maybe at the beginning of the guide? I
> wrote a Linux install guide on the forums that can be "wikified":
>
> http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
>
> In the near future I can start with the Writer and Math guides, but someone
> needs to take care of other components.
>
> Thoughts? Volunteers? ;)
>
> Regards
> Ricardo
>
>
>
> > Even if there is some content scattered on those pages (the UI page and
> > Java section under Options menu... someone needs to check my grammar)
> they
> > are mainly empty right now, but on the following days I'll try to
> translate
> > what it is already done on the ES wiki
> >
> > http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
> >
> > Regards
> > Ricardo
> >
> >
> >
> > 2013/1/15 RGB ES <rg...@gmail.com>
> >
> >> 2013/1/13 Regina Henschel <rb...@t-online.de>
> >>
> >>> Hi Ricardo,
> >>>
> >>> RGB ES schrieb:
> >>>
> >>> <snip>
> >>>
> >>>
> >>> I propose to omit the version number level. As can be seen for
> >>> ODFAuthors it is unlikely, that all documents are new written for a new
> >>> version and sometimes it is not needed at all. LibreOffice 4.0 is in
> RC1,
> >>> but some documents are for 3.4, some for 3.5, and 3.6 is missing
> totally.
> >>> The situation becomes worse, if you think of documentations in other
> >>> languages.
> >>>
> >>> I propose this way: Use a hierarchy
> >>> /wiki/Documentation/UserGuide/**Tips/Writer
> >>> or
> >>> /wiki/Documentation/UserGuide/**Writer/Tips
> >>> I'm not sure about the best order.
> >>>
> >>> If some content becomes outdated and has to be replaced, then generate
> a
> >>> new page with the same title, but a version addition.
> >>>
> >>> Example: A outdated content in the path
> >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
> >>> would be copied to a path
> >>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
> >>> and the original page gets a comment line with a link to the old
> version
> >>> and the old version gets a comment line back to the newer version.
> >>> This has to be done by the person, who writes the new content.
> >>>
> >>> This has the advantage, that there will be no tree of empty pages, but
> >>> the user will always come to the most actual document, when he starts
> in
> >>> /wiki/Documentation and follows the tree.
> >>>
> >>
> >> Good point! I like the idea of moving outdated content to sub-pages.
> >>
> >>
> >>
> >>>
> >>> In the start, when not enough actual content is available, this single
> >>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents
> or
> >>> other suitable wiki pages.
> >>>
> >>>
> >>>
> >>>
> >>>> The idea is to create all the pages at once, with just the categories
> >>>> "Documentation" and "UserGuide" and a template similar to the one we
> >>>> use on
> >>>> the ES wiki(2) for "work in process new pages", that we can call
> "Draft"
> >>>> (not sure if there is one already: I cannot find it).
> >>>>
> >>>
> >>> Creating a new "UserGuide" section is OK, but same other sections need
> >>> to be there from the beginning too. I think of pathes to the developers
> >>> guide, to the building guide, to the QA tutorials, to the Calc
> functions
> >>> reference.
> >>
> >>
> >> Sure. We can update the main documentation page(1) to gather all those
> >> elements on one place.
> >>
> >> (1) http://wiki.openoffice.org/wiki/Documentation
> >>
> >>
> >>
> >>>
> >>>
> >>>
> >>>> In parallel, we can start discussing about writing style, screenshots
> >>>> (desktop theme...) and related problems on other topics.
> >>>>
> >>>
> >>> There is the page http://wiki.openoffice.org/**
> >>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy
> >.
> >>> It is already fairly good, and can be used as start. Adaption to AOO
> is of
> >>> cause needed.
> >>
> >>
> >> Thanks for the link! Looking there I see that the DraftPage template is
> >> already present: {{Documentation/DraftPage}}
> >>
> >>
> >>
> >>>
> >>>
> >>>
> >>>> After "seeding" some pages with content we start a call for authors
> and
> >>>> the
> >>>> "real writing"(3). Finally, when the author is ready he/she calls for
> >>>> review/proof reading and when every is OK we delete the "Draft"
> >>>> template.
> >>>>
> >>>> What do you think?
> >>>>
> >>>
> >>> I fear, a lot a pages will stay "draft" for ever.
> >>>
> >>> What are your plans about the old Dokumentation hierarchy ?
> >>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
> >>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
> >>> of_the_Wiki<
> http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki
> >
> >>
> >>
> >>
> >> No plans, for the moment. I just tried to start the discussion for a
> self
> >> contained 4.0 user guide written from scratch and easy to maintain.
> >>
> >> The structure of the Documentation section on the wiki is indeed quite
> >> complex and it is difficult for a new user to tell apart what's still
> >> valid. Maybe we need to make a completely fresh start here, moving old
> >> content to a "legacy" section... but on the other hand we cannot left
> the
> >> site empty.
> >>
> >> Regards
> >> Ricardo
> >>
> >>
> >>
> >>>
> >>>
> >>> Kind regards
> >>> Regina
> >>>
> >>>
> >>
> >
>
--
XOXOXOXO
Bonnie Smith Ries
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by "Keith N. McKenna" <ke...@comcast.net>.
RGB ES wrote:
> 2013/1/18 RGB ES <rg...@gmail.com>
>
>> I started to create the User Guide pages on the wiki
>>
>> http://wiki.openoffice.org/wiki/Documentation/UserGuide
>>
>>
>
> I need some help here. There are now several pages covering the beginning
> of the guide
>
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
> and the sub page
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
>
> All these pages needs proofreading (as you can see, English is not my
> native language) and someone that fill their holes.
>
> The page about supported file formats is completely empty and needs an
> author
> http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
>
> I think a general spellcheck guide is also needed, but not sure where to
> put it on the "tree". Maybe below Formatting and before SearchReplace?
>
> Also, install guides are needed, maybe at the beginning of the guide? I
> wrote a Linux install guide on the forums that can be "wikified":
>
> http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
>
> In the near future I can start with the Writer and Math guides, but someone
> needs to take care of other components.
>
> Thoughts? Volunteers? ;)
>
> Regards
> Ricardo
>
Ricardo;
I have started proofreading
http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI.
Regards
Keith
>
>
>> Even if there is some content scattered on those pages (the UI page and
>> Java section under Options menu... someone needs to check my grammar) they
>> are mainly empty right now, but on the following days I'll try to translate
>> what it is already done on the ES wiki
>>
>> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
>>
>> Regards
>> Ricardo
>>
>>
>>
>> 2013/1/15 RGB ES <rg...@gmail.com>
>>
>>> 2013/1/13 Regina Henschel <rb...@t-online.de>
>>>
>>>> Hi Ricardo,
>>>>
>>>> RGB ES schrieb:
>>>>
>>>> <snip>
>>>>
>>>>
>>>> I propose to omit the version number level. As can be seen for
>>>> ODFAuthors it is unlikely, that all documents are new written for a new
>>>> version and sometimes it is not needed at all. LibreOffice 4.0 is in RC1,
>>>> but some documents are for 3.4, some for 3.5, and 3.6 is missing totally.
>>>> The situation becomes worse, if you think of documentations in other
>>>> languages.
>>>>
>>>> I propose this way: Use a hierarchy
>>>> /wiki/Documentation/UserGuide/**Tips/Writer
>>>> or
>>>> /wiki/Documentation/UserGuide/**Writer/Tips
>>>> I'm not sure about the best order.
>>>>
>>>> If some content becomes outdated and has to be replaced, then generate a
>>>> new page with the same title, but a version addition.
>>>>
>>>> Example: A outdated content in the path
>>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>>>> would be copied to a path
>>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>>>> and the original page gets a comment line with a link to the old version
>>>> and the old version gets a comment line back to the newer version.
>>>> This has to be done by the person, who writes the new content.
>>>>
>>>> This has the advantage, that there will be no tree of empty pages, but
>>>> the user will always come to the most actual document, when he starts in
>>>> /wiki/Documentation and follows the tree.
>>>>
>>>
>>> Good point! I like the idea of moving outdated content to sub-pages.
>>>
>>>
>>>
>>>>
>>>> In the start, when not enough actual content is available, this single
>>>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents or
>>>> other suitable wiki pages.
>>>>
>>>>
>>>>
>>>>
>>>>> The idea is to create all the pages at once, with just the categories
>>>>> "Documentation" and "UserGuide" and a template similar to the one we
>>>>> use on
>>>>> the ES wiki(2) for "work in process new pages", that we can call "Draft"
>>>>> (not sure if there is one already: I cannot find it).
>>>>>
>>>>
>>>> Creating a new "UserGuide" section is OK, but same other sections need
>>>> to be there from the beginning too. I think of pathes to the developers
>>>> guide, to the building guide, to the QA tutorials, to the Calc functions
>>>> reference.
>>>
>>>
>>> Sure. We can update the main documentation page(1) to gather all those
>>> elements on one place.
>>>
>>> (1) http://wiki.openoffice.org/wiki/Documentation
>>>
>>>
>>>
>>>>
>>>>
>>>>
>>>>> In parallel, we can start discussing about writing style, screenshots
>>>>> (desktop theme...) and related problems on other topics.
>>>>>
>>>>
>>>> There is the page http://wiki.openoffice.org/**
>>>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy>.
>>>> It is already fairly good, and can be used as start. Adaption to AOO is of
>>>> cause needed.
>>>
>>>
>>> Thanks for the link! Looking there I see that the DraftPage template is
>>> already present: {{Documentation/DraftPage}}
>>>
>>>
>>>
>>>>
>>>>
>>>>
>>>>> After "seeding" some pages with content we start a call for authors and
>>>>> the
>>>>> "real writing"(3). Finally, when the author is ready he/she calls for
>>>>> review/proof reading and when every is OK we delete the "Draft"
>>>>> template.
>>>>>
>>>>> What do you think?
>>>>>
>>>>
>>>> I fear, a lot a pages will stay "draft" for ever.
>>>>
>>>> What are your plans about the old Dokumentation hierarchy ?
>>>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>>>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>>>> of_the_Wiki<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki>
>>>
>>>
>>>
>>> No plans, for the moment. I just tried to start the discussion for a self
>>> contained 4.0 user guide written from scratch and easy to maintain.
>>>
>>> The structure of the Documentation section on the wiki is indeed quite
>>> complex and it is difficult for a new user to tell apart what's still
>>> valid. Maybe we need to make a completely fresh start here, moving old
>>> content to a "legacy" section... but on the other hand we cannot left the
>>> site empty.
>>>
>>> Regards
>>> Ricardo
>>>
>>>
>>>
>>>>
>>>>
>>>> Kind regards
>>>> Regina
>>>>
>>>>
>>>
>>
>
Re: Starting to build the user guide [Was Re: Possible workflow]
Posted by RGB ES <rg...@gmail.com>.
2013/1/18 RGB ES <rg...@gmail.com>
> I started to create the User Guide pages on the wiki
>
> http://wiki.openoffice.org/wiki/Documentation/UserGuide
>
>
I need some help here. There are now several pages covering the beginning
of the guide
http://wiki.openoffice.org/wiki/Documentation/UserGuide/UI
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Formatting
http://wiki.openoffice.org/wiki/Documentation/UserGuide/SearchReplace
http://wiki.openoffice.org/wiki/Documentation/UserGuide/AutoCorrect
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Extensions
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options
and the sub page
http://wiki.openoffice.org/wiki/Documentation/UserGuide/Options/AOO
All these pages needs proofreading (as you can see, English is not my
native language) and someone that fill their holes.
The page about supported file formats is completely empty and needs an
author
http://wiki.openoffice.org/wiki/Documentation/UserGuide/FileFormats
I think a general spellcheck guide is also needed, but not sure where to
put it on the "tree". Maybe below Formatting and before SearchReplace?
Also, install guides are needed, maybe at the beginning of the guide? I
wrote a Linux install guide on the forums that can be "wikified":
http://forum.openoffice.org/en/forum/viewtopic.php?f=74&t=50119
In the near future I can start with the Writer and Math guides, but someone
needs to take care of other components.
Thoughts? Volunteers? ;)
Regards
Ricardo
> Even if there is some content scattered on those pages (the UI page and
> Java section under Options menu... someone needs to check my grammar) they
> are mainly empty right now, but on the following days I'll try to translate
> what it is already done on the ES wiki
>
> http://wiki.openoffice.org/wiki/ES/Manuales/GuiaAOO
>
> Regards
> Ricardo
>
>
>
> 2013/1/15 RGB ES <rg...@gmail.com>
>
>> 2013/1/13 Regina Henschel <rb...@t-online.de>
>>
>>> Hi Ricardo,
>>>
>>> RGB ES schrieb:
>>>
>>> <snip>
>>>
>>>
>>> I propose to omit the version number level. As can be seen for
>>> ODFAuthors it is unlikely, that all documents are new written for a new
>>> version and sometimes it is not needed at all. LibreOffice 4.0 is in RC1,
>>> but some documents are for 3.4, some for 3.5, and 3.6 is missing totally.
>>> The situation becomes worse, if you think of documentations in other
>>> languages.
>>>
>>> I propose this way: Use a hierarchy
>>> /wiki/Documentation/UserGuide/**Tips/Writer
>>> or
>>> /wiki/Documentation/UserGuide/**Writer/Tips
>>> I'm not sure about the best order.
>>>
>>> If some content becomes outdated and has to be replaced, then generate a
>>> new page with the same title, but a version addition.
>>>
>>> Example: A outdated content in the path
>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar
>>> would be copied to a path
>>> /wiki/Documentation/UserGuide/**General/UI/Customize_Toolbar_**3_4
>>> and the original page gets a comment line with a link to the old version
>>> and the old version gets a comment line back to the newer version.
>>> This has to be done by the person, who writes the new content.
>>>
>>> This has the advantage, that there will be no tree of empty pages, but
>>> the user will always come to the most actual document, when he starts in
>>> /wiki/Documentation and follows the tree.
>>>
>>
>> Good point! I like the idea of moving outdated content to sub-pages.
>>
>>
>>
>>>
>>> In the start, when not enough actual content is available, this single
>>> comment line can link to the existing ODFAuthors 3.3 or 3.2 documents or
>>> other suitable wiki pages.
>>>
>>>
>>>
>>>
>>>> The idea is to create all the pages at once, with just the categories
>>>> "Documentation" and "UserGuide" and a template similar to the one we
>>>> use on
>>>> the ES wiki(2) for "work in process new pages", that we can call "Draft"
>>>> (not sure if there is one already: I cannot find it).
>>>>
>>>
>>> Creating a new "UserGuide" section is OK, but same other sections need
>>> to be there from the beginning too. I think of pathes to the developers
>>> guide, to the building guide, to the QA tutorials, to the Calc functions
>>> reference.
>>
>>
>> Sure. We can update the main documentation page(1) to gather all those
>> elements on one place.
>>
>> (1) http://wiki.openoffice.org/wiki/Documentation
>>
>>
>>
>>>
>>>
>>>
>>>> In parallel, we can start discussing about writing style, screenshots
>>>> (desktop theme...) and related problems on other topics.
>>>>
>>>
>>> There is the page http://wiki.openoffice.org/**
>>> wiki/Documentation/Dashboard/**Wiki_Editing_Policy<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy>.
>>> It is already fairly good, and can be used as start. Adaption to AOO is of
>>> cause needed.
>>
>>
>> Thanks for the link! Looking there I see that the DraftPage template is
>> already present: {{Documentation/DraftPage}}
>>
>>
>>
>>>
>>>
>>>
>>>> After "seeding" some pages with content we start a call for authors and
>>>> the
>>>> "real writing"(3). Finally, when the author is ready he/she calls for
>>>> review/proof reading and when every is OK we delete the "Draft"
>>>> template.
>>>>
>>>> What do you think?
>>>>
>>>
>>> I fear, a lot a pages will stay "draft" for ever.
>>>
>>> What are your plans about the old Dokumentation hierarchy ?
>>> http://wiki.openoffice.org/**wiki/Documentation/Dashboard/**
>>> Wiki_Editing_Policy#Structure_**of_the_Documentation_Section_**
>>> of_the_Wiki<http://wiki.openoffice.org/wiki/Documentation/Dashboard/Wiki_Editing_Policy#Structure_of_the_Documentation_Section_of_the_Wiki>
>>
>>
>>
>> No plans, for the moment. I just tried to start the discussion for a self
>> contained 4.0 user guide written from scratch and easy to maintain.
>>
>> The structure of the Documentation section on the wiki is indeed quite
>> complex and it is difficult for a new user to tell apart what's still
>> valid. Maybe we need to make a completely fresh start here, moving old
>> content to a "legacy" section... but on the other hand we cannot left the
>> site empty.
>>
>> Regards
>> Ricardo
>>
>>
>>
>>>
>>>
>>> Kind regards
>>> Regina
>>>
>>>
>>
>