Mailing-List: contact ooo-dev-help@incubator.apache.org; run by ezmlm
Precedence: bulk
Reply-To: ooo-dev@incubator.apache.org
Received-SPF: pass (athena.apache.org: domain of dennis.hamilton@acm.org
 designates 75.98.160.131 as permitted sender)
Reply-To: <dennis.hamilton@acm.org>
From: "Dennis E. Hamilton" <dennis.hamilton@acm.org>
To: <ooo-dev@incubator.apache.org>
Cc: <jogischmidt@googlemail.com>
Subject: API Docs Versioning (was RE: [PATCH] fieldmaster)
Date: Fri, 10 Feb 2012 12:30:31 -0800
Organization: NuovoDoc
Message-ID: <014c01cce832$d6948c10$83bda430$@acm.org>
MIME-Version: 1.0
Content-Type: text/plain;
	charset="utf-8"
Content-Transfer-Encoding: quoted-printable
Thread-Index: AczoK+XNYkx1zKwyTVCjgD0E0sz41A==
Content-Language: en-us

J=C3=BCrgen,

Thanks for the useful information on what portions of the site are =
generated.

I have some related questions:

 1. I see that the API pages indicate the release that they apply for.  =
Is there anything in these pages that indicates the earliest release in =
which particular content was introduced in its present form?

 2. Is there some sort of deprecation indication for aspects that will =
no longer be supported at some point, or for items that are not now =
supported (just to reflect their removal)?

 3. If someone wants to know or work with earlier versions of the API, =
is there information on how to find those earlier references?  Would it =
be by obtaining earlier releases of the SDK?

I apologize if these questions are already answered.  I did not survey =
the API section very carefully.

 - Dennis


-----Original Message-----
From: J=C3=BCrgen Schmidt [mailto:jogischmidt@googlemail.com]=20
Sent: Friday, February 10, 2012 02:43
To: ooo-dev@incubator.apache.org
Subject: Re: [PATCH] fieldmaster

On 2/9/12 11:20 PM, Kay Schenk wrote:
> On Thu, Feb 9, 2012 at 12:03 PM, Dave Fisher<dave2wave@comcast.net>  =
wrote:
>
>> Hi Dennis,
>>
>> Kay recently updated this page:
>>
>> http://incubator.apache.org/openofficeorg/website-local.html
>>
>> Does this provide any illumination for you?
>>
>> AFAIK - api is a special case and was discussed in the past. I'll =
find the
>> thread if needed.
>>
>
> ditto on this from me...I'm perfectly happy editing areas as long as =
I'm
> convinced I'll "do no harm". api specs...maybe not.

in the api section of the web site the following area is automatically=20
generated as part of the SDK build process.

api/docs/common/ref/... [1]
api/docs/cpp/ref/...  [2]
api/docs/java/ref/...  [3]

[1] the IDL reference documentation
[2] the C++ UNO runtime reference
[3] the Java UNO runtime reference

These section gets always updated after a new release. It's the same=20
documentation that is also part of the SDK

I hope that make it a little bit more clear

Juergen

>
>
>>
>> Regards,
>> Dave
>>
>> On Feb 9, 2012, at 11:59 AM, Dennis E. Hamilton wrote:
>>
>>> I am not clear what is what would be called the maintainable source =
in
>> the case of the ooo-site.
>>>
>>> It is useful to know that some of the pages are generated =
automatically
>> as byproducts of other processes (such as an IDL processor/generator) =
and
>> are not the maintainable source.
>>>
>>> I wonder if there are places in the ooo-site publication staging- =
and
>> tool-chain where one also must be careful not to patch downstream =
from the
>> preferred source.
>>>
>>> Knowing there are other steps needed beyond committing working-copy
>> changes to the ooo-site SVN is more mystery meat.  The only way I =
have seen
>> for triggering publishing of the site is on the CMS browser =
interface.  I
>> have no idea if that is the place for performing the missing step.
>>>
>>> - Dennis
>>>
>>>
>>>
>>> -----Original Message-----
>>> From: J=C3=BCrgen Schmidt [mailto:jogischmidt@googlemail.com]
>>> Sent: Wednesday, February 08, 2012 23:59
>>> To: ooo-dev@incubator.apache.org
>>> Subject: Re: [PATCH] fieldmaster
>>>
>>> Hi Joe,
>>>
>>>
>>> On 2/9/12 3:22 AM, Joe Schaefer wrote:
>>>> Well no, but the beauty of svn is that you only need
>>>> to deal with the section of the tree you are interested
>>>> in.  So don't check-out all of ooo-site just to apply this
>>>> tiny patch- look at the patch to see which directory
>>>> it applies to and just check-out THAT.
>>>>
>>>>
>>>> Applying the patch is a matter of cd'ing to that
>>>> directory and running
>>>>
>>>> % patch<   path/to/email/msg.txt
>>>> % svn commit -m 'apply fieldmaster patch'
>>>>
>>>
>>> I hope you can give me a hint what I am missing...
>>>
>>>
>>> I checked out
>>> =
http://svn.apache.org/viewvc/incubator/ooo/ooo-site/trunk/content/api
>>> some time ago and made some changes for example in the index.html =
(e.g.
>>> removed the project lead names)
>>>
>>> I checked the content locally and check in the index.html. But when =
I
>>> browse the API site my changes are not yet visible there.
>>>
>>> Which step is missing?
>>>
>>> Juergen
>>>
>>>
>>>>
>>>> ----- Original Message -----
>>>>> From: Rob Weir<robweir@apache.org>
>>>>> To: ooo-dev@incubator.apache.org
>>>>> Cc:
>>>>> Sent: Wednesday, February 8, 2012 9:17 PM
>>>>> Subject: Re: [PATCH] fieldmaster
>>>>>
>>>>> On Wed, Feb 8, 2012 at 3:22 PM, Joe =
Schaefer<joe_schaefer@yahoo.com>
>>>>> wrote:
>>>>>>   No idea if this is sufficient Ric, but I used the CMS
>>>>>>   to email this patch as I explained earlier.
>>>>>>
>>>>>
>>>>> Cool.  But unless we have more committers download ooo-site and =
set up
>>>>> an off-line site build environment, these patches are going to be =
slow
>>>>> to integrate.  I'm guilty as well.  I'll find some time to get =
this
>>>>> set up on my machine.
>>>>>
>>>>> Or is there any easier way to suck these patches into the CMS?  =
For
>>>>> example, it would be really cool if there was an "upload/apply =
patch"
>>>>> button in the CMS "edit" view.  That would enable any committer to
>>>>> review and apply site patches, even the ones not comfortable with =
SVN
>>>>> and command-line tools.
>>>>>
>>>>> -Rob
>>>>>
>>>>>>
>>>>>>
>>>>>>   ----- Original Message -----
>>>>>>>   From: Joe Schaefer<joes@apache.org>
>>>>>>>   To: ooo-dev@incubator.apache.org
>>>>>>>   Cc:
>>>>>>>   Sent: Wednesday, December 31, 1969 7:00 PM
>>>>>>>   Subject: [PATCH] fieldmaster
>>>>>>>
>>>>>>>   Here's the patch for Ric's issue.
>>>>>>   ...
>>>>>>
>>>>>
>>>
>>
>>
>
>