Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Thorsten Behrens]

Lionel Elie Mamane wrote:
> Who can regenerated api.libreoffice.org from up-to-date
> libreoffice-4-1 (or master?) branch?
> 
Hi Miklos,

I keep forgetting - was it you taking care of that?

Thanks,

-- Thorsten


signature.asc
Description: Digital signature
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Andras Timar]

On Wed, Sep 4, 2013 at 8:40 PM, Thorsten Behrens
 wrote:
> Lionel Elie Mamane wrote:
>> Who can regenerated api.libreoffice.org from up-to-date
>> libreoffice-4-1 (or master?) branch?
>>
> Hi Miklos,
>
> I keep forgetting - was it you taking care of that?
>

LOL. It's me. I'll do it ASAP.

Andras
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Andras Timar]

On Wed, Sep 4, 2013 at 6:25 PM, Lionel Elie Mamane  wrote:
> On Sat, Aug 03, 2013 at 02:00:28PM +0200, Lionel Elie Mamane wrote:
>> On Sat, Aug 03, 2013 at 09:54:33AM +0200, Stephan Bergmann wrote:
>
>>> On 08/03/2013 02:56 AM, Thorsten Behrens wrote:
 * API date issue (Lionel/Stephan)
  + patches pending on gerrit for -4-1
 AI: + review & get them in before Monday:
https://gerrit.libreoffice.org/5245
>
>>> So, consensus appears to be to go with option 1 ("Break ABI/API in
>>> 4.1.1") from
>>> 
>>> "More time-related API headache"?  Did you happen to have any
>>> further discussion about it during the ESC meeting?
>
> So, we did that for LibreOffice 4.1, but api.libreoffice.org still
> documents the old API. Who can regenerated api.libreoffice.org from
> up-to-date libreoffice-4-1 (or master?) branch?
>

I updated api.libreoffice.org from master.

Cheers,
Andras
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Stephan Bergmann]

On 09/04/2013 11:56 PM, Andras Timar wrote:

On Wed, Sep 4, 2013 at 6:25 PM, Lionel Elie Mamane  wrote:

On Sat, Aug 03, 2013 at 02:00:28PM +0200, Lionel Elie Mamane wrote:

On Sat, Aug 03, 2013 at 09:54:33AM +0200, Stephan Bergmann wrote:



On 08/03/2013 02:56 AM, Thorsten Behrens wrote:

* API date issue (Lionel/Stephan)
  + patches pending on gerrit for -4-1
AI: + review & get them in before Monday:
https://gerrit.libreoffice.org/5245



So, consensus appears to be to go with option 1 ("Break ABI/API in
4.1.1") from

"More time-related API headache"?  Did you happen to have any
further discussion about it during the ESC meeting?


So, we did that for LibreOffice 4.1, but api.libreoffice.org still
documents the old API. Who can regenerated api.libreoffice.org from
up-to-date libreoffice-4-1 (or master?) branch?



I updated api.libreoffice.org from master.


Thanks Andras,

 
(linked as "IDL Reference" from ) gives 404.


And  (linked as "C++ 
Reference" from ) still claims "LibreOffice 
4.1.0.0.alpha0+ SDK C/C++ API Reference," so I'm not sure whether the 
website files didn't get updated, or got updated from a stale master build.


Also, it occurs to me that we should give the SDK version number also on 
the main  page, to avoid confusion.  I'll 
look into the odk/ sources from which it is generated.


Finally, can you give a quick instructions how to update that site (what 
permissions does one need to request where, etc.)?  Would probably make 
sense to have more people able to do that (and sure, I'd volunteer to be 
one of them).


Stephan
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Andras Timar]

Hi Stephan,

On Thu, Sep 5, 2013 at 8:41 AM, Stephan Bergmann  wrote:
> 
> (linked as "IDL Reference" from ) gives 404.
>
> And  (linked as "C++
> Reference" from ) still claims "LibreOffice
> 4.1.0.0.alpha0+ SDK C/C++ API Reference," so I'm not sure whether the
> website files didn't get updated, or got updated from a stale master build.
>

It is your browser cache, force reload, and it will be fine.

> Also, it occurs to me that we should give the SDK version number also on the
> main  page, to avoid confusion.  I'll look into
> the odk/ sources from which it is generated.

The index.html of the site is the only one that needs manual editing,
because of the Google search widget. All other files/pages are
verbatim copies of build output.

>
> Finally, can you give a quick instructions how to update that site (what
> permissions does one need to request where, etc.)?  Would probably make
> sense to have more people able to do that (and sure, I'd volunteer to be one
> of them).
>

I maintain a local copy of the website, in order to keep index.html
and favicon.ico, I overwrite docs and examples folders with the docs
and examples folders from install/odk, then I rsync the local copy of
the site to 
libreoff...@gimli.documentfoundation.org:/srv/www/api.libreoffice.org/
(rsync -avz --delete).

Cheers,
Andras
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Alexander Thurgood]

Le 05/09/13 09:33, Andras Timar a écrit :

Hi Andras,

I've seen two user reports of similar problems (404 not found), one
yesterday on the French list and one today on the EN user list.

Alex


___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Alexander Thurgood]

Le 05/09/13 09:33, Andras Timar a écrit :

Hi Andras,

> It is your browser cache, force reload, and it will be fine.
> 

I gave this advice to a user on the EN mailing list, and now they can't
connect to any of the indexes at all.


Alex

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Andras Timar]

Hi Alex

On Fri, Sep 6, 2013 at 5:36 PM, Alexander Thurgood
 wrote:
> I've seen two user reports of similar problems (404 not found), one
> yesterday on the French list and one today on the EN user list.

It is possible that deep links from external sites do not work any
more. The autodoc -> doxygen transition changed many links. Hopefully
Google will reindex the site soon, so people can use Google search
again.

The site contains 23881 links, and there are only ~30 broken links,
which are caused by the following line in odk/CustomTarget_javadoc.mk:
 -linkoffline ../../common/reg $(SRCDIR)/odk/pack/gendocu/uno \

There is no common directory any more, and unfortunately
common/reg/com/sun/star paths became part of the filename, like
exceptioncom_1_1sun_1_1star_1_1uno_1_1RuntimeException.html. So links
from javadocs to API docs should be fixed somehow.

Best regards,
Andras
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Jonathan Aquilina]

Andras would resubmitting a new sitemap to Google help the situation at all?


On Sat, Sep 7, 2013 at 3:33 PM, Andras Timar  wrote:

> Hi Alex
>
> On Fri, Sep 6, 2013 at 5:36 PM, Alexander Thurgood
>  wrote:
> > I've seen two user reports of similar problems (404 not found), one
> > yesterday on the French list and one today on the EN user list.
>
> It is possible that deep links from external sites do not work any
> more. The autodoc -> doxygen transition changed many links. Hopefully
> Google will reindex the site soon, so people can use Google search
> again.
>
> The site contains 23881 links, and there are only ~30 broken links,
> which are caused by the following line in odk/CustomTarget_javadoc.mk:
>  -linkoffline ../../common/reg $(SRCDIR)/odk/pack/gendocu/uno \
>
> There is no common directory any more, and unfortunately
> common/reg/com/sun/star paths became part of the filename, like
> exceptioncom_1_1sun_1_1star_1_1uno_1_1RuntimeException.html. So links
> from javadocs to API docs should be fixed somehow.
>
> Best regards,
> Andras
> ___
> LibreOffice mailing list
> LibreOffice@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/libreoffice
>



-- 
Jonathan Aquilina
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Lionel Elie Mamane]

On Thu, Sep 05, 2013 at 08:41:08AM +0200, Stephan Bergmann wrote:
> On 09/04/2013 11:56 PM, Andras Timar wrote:
>> On Wed, Sep 4, 2013 at 6:25 PM, Lionel Elie Mamane  wrote:
>>> On Sat, Aug 03, 2013 at 02:00:28PM +0200, Lionel Elie Mamane wrote:
 On Sat, Aug 03, 2013 at 09:54:33AM +0200, Stephan Bergmann wrote:

>>>  Who can regenerated api.libreoffice.org from
>>> up-to-date libreoffice-4-1 (or master?) branch?

>> I updated api.libreoffice.org from master.

> Also, it occurs to me that we should give the SDK version number
> also on the main  page, to avoid
> confusion.  I'll look into the odk/ sources from which it is
> generated.

Actually, it could make sense to document the API available in each
version, that is, have something like:

http://api.libreoffice.org/docs/3.3/idl/
http://api.libreoffice.org/docs/3.6/idl/
http://api.libreoffice.org/docs/4.0/idl/
http://api.libreoffice.org/docs/4.1/idl/
http://api.libreoffice.org/docs/4.2/idl/
http://api.libreoffice.org/docs/current/idl/

Ditto for doc/cpp, etc. Since we are breaking ~all deep links anyway,
now is as good a time as ever to switch to such a scheme.

-- 
Lionel
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Lionel Elie Mamane]

On Thu, Sep 05, 2013 at 09:33:57AM +0200, Andras Timar wrote:
> On Thu, Sep 5, 2013 at 8:41 AM, Stephan Bergmann  wrote:

>> Finally, can you give a quick instructions how to update that site (what
>> permissions does one need to request where, etc.)?  Would probably make
>> sense to have more people able to do that (and sure, I'd volunteer to be one
>> of them).

> I maintain a local copy of the website, in order to keep index.html
> and favicon.ico, I overwrite docs and examples folders with the docs
> and examples folders from install/odk, then I rsync the local copy of
> the site to 
> libreoff...@gimli.documentfoundation.org:/srv/www/api.libreoffice.org/
> (rsync -avz --delete).

I'd be rather in favour of moving this to a cronjob, or at least to
our release check-list / procedure / ...

index.html and favicon.ico could be in git, couldn't they?

-- 
Lionel
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Eike Rathke]

Hi,

On Monday, 2013-09-09 10:38:16 +0200, Lionel Elie Mamane wrote:

> Actually, it could make sense to document the API available in each
> version, that is, have something like:
> 
> http://api.libreoffice.org/docs/3.3/idl/
> http://api.libreoffice.org/docs/3.6/idl/
> http://api.libreoffice.org/docs/4.0/idl/
> http://api.libreoffice.org/docs/4.1/idl/
> http://api.libreoffice.org/docs/4.2/idl/
> http://api.libreoffice.org/docs/current/idl/
> 
> Ditto for doc/cpp, etc. Since we are breaking ~all deep links anyway,
> now is as good a time as ever to switch to such a scheme.

I favour this one, it preserves all information and gives the user
a chance to compare changes. For future releases when the doxygen
changes will have calmed down we could even generate diffs between
versions.

  Eike

-- 
LibreOffice Calc developer. Number formatter stricken i18n transpositionizer.
GPG key ID: 0x65632D3A - 2265 D7F3 A7B0 95CC 3918  630B 6A6C D5B7 6563 2D3A
For key transition see http://erack.de/key-transition-2013-01-10.txt.asc
Support the FSFE, care about Free Software! https://fsfe.org/support/?erack


pgpjAEbzz52Um.pgp
Description: PGP signature
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[James Michael DuPont]

I have built the git master and ran the make docs, it produced doxygen but
did not produce any IDL/API docs,
http://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1text_1_1textfield_1_1JumpEdit.htmlthis
is not being generated for example, any instructions on how to process
the IDL?


On Mon, Sep 9, 2013 at 3:38 AM, Lionel Elie Mamane  wrote:

> On Thu, Sep 05, 2013 at 08:41:08AM +0200, Stephan Bergmann wrote:
> > On 09/04/2013 11:56 PM, Andras Timar wrote:
> >> On Wed, Sep 4, 2013 at 6:25 PM, Lionel Elie Mamane 
> wrote:
> >>> On Sat, Aug 03, 2013 at 02:00:28PM +0200, Lionel Elie Mamane wrote:
>  On Sat, Aug 03, 2013 at 09:54:33AM +0200, Stephan Bergmann wrote:
>
> >>>  Who can regenerated api.libreoffice.org from
> >>> up-to-date libreoffice-4-1 (or master?) branch?
>
> >> I updated api.libreoffice.org from master.
>
> > Also, it occurs to me that we should give the SDK version number
> > also on the main  page, to avoid
> > confusion.  I'll look into the odk/ sources from which it is
> > generated.
>
> Actually, it could make sense to document the API available in each
> version, that is, have something like:
>
> http://api.libreoffice.org/docs/3.3/idl/
> http://api.libreoffice.org/docs/3.6/idl/
> http://api.libreoffice.org/docs/4.0/idl/
> http://api.libreoffice.org/docs/4.1/idl/
> http://api.libreoffice.org/docs/4.2/idl/
> http://api.libreoffice.org/docs/current/idl/
>
> Ditto for doc/cpp, etc. Since we are breaking ~all deep links anyway,
> now is as good a time as ever to switch to such a scheme.
>
> --
> Lionel
> ___
> LibreOffice mailing list
> LibreOffice@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/libreoffice
>
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Stephan Bergmann]

On 09/11/2013 04:16 PM, James Michael DuPont wrote:

I have built the git master and ran the make docs, it produced doxygen
but did not produce any IDL/API docs,
http://api.libreoffice.org/docs/idl/ref/servicecom_1_1sun_1_1star_1_1text_1_1textfield_1_1JumpEdit.html
this is not being generated for example, any instructions on how to
process the IDL?


Looks like "make docs" does something rather unrelated, extracting 
doxygen documentation from LO's "core" C++ files.


The SDK API documentation you seek is part of the SDK product.  If you 
do a very recent master build (post this weeks instdir improvements), 
you find it at instdir/*/sdk/index.html (at least on Linux, paths differ 
across platforms) after a plain "make" (unless you configured 
--disable-odk).


Stephan

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Michael Stahl]

On 09/09/13 10:38, Lionel Elie Mamane wrote:
> On Thu, Sep 05, 2013 at 08:41:08AM +0200, Stephan Bergmann wrote:
>> On 09/04/2013 11:56 PM, Andras Timar wrote:
> 
>> Also, it occurs to me that we should give the SDK version number
>> also on the main  page, to avoid
>> confusion.  I'll look into the odk/ sources from which it is
>> generated.
> 
> Actually, it could make sense to document the API available in each
> version, that is, have something like:
> 
> http://api.libreoffice.org/docs/3.3/idl/
> http://api.libreoffice.org/docs/3.6/idl/
> http://api.libreoffice.org/docs/4.0/idl/
> http://api.libreoffice.org/docs/4.1/idl/
> http://api.libreoffice.org/docs/4.2/idl/
> http://api.libreoffice.org/docs/current/idl/
> 
> Ditto for doc/cpp, etc. Since we are breaking ~all deep links anyway,
> now is as good a time as ever to switch to such a scheme.

i'm not convinced it's a good idea - it would only make a difference for
incompatible changes, since the compatible changes would be annotated
with @since tags anyway.  and incompatible changes ought to be rare; i'm
hoping we won't do these every release.

but maybe putting in a link somewhere to the API Changes section of the
release notes would help?


___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Michael Stahl]

On 07/09/13 15:33, Andras Timar wrote:
> On Fri, Sep 6, 2013 at 5:36 PM, Alexander Thurgood
>  wrote:
>> I've seen two user reports of similar problems (404 not found), one
>> yesterday on the French list and one today on the EN user list.
> 
> It is possible that deep links from external sites do not work any
> more. The autodoc -> doxygen transition changed many links. Hopefully
> Google will reindex the site soon, so people can use Google search
> again.
> 
> The site contains 23881 links, and there are only ~30 broken links,
> which are caused by the following line in odk/CustomTarget_javadoc.mk:
>  -linkoffline ../../common/reg $(SRCDIR)/odk/pack/gendocu/uno \
> 
> There is no common directory any more, and unfortunately
> common/reg/com/sun/star paths became part of the filename, like
> exceptioncom_1_1sun_1_1star_1_1uno_1_1RuntimeException.html. So links
> from javadocs to API docs should be fixed somehow.

yes this is a known problem with doxygen, it wants to encode the type of
an entity into the filename, which makes linking annoyingly painful.

i even wrote a patch to add a PREDICTABLE_URLS option but it was not
merged upstream:
http://permalink.gmane.org/gmane.text.doxygen.devel/1313

with that patch the links could be automatically rewritten or even
redirected just by replacing "/" with "_1_1".

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[James Michael DuPont]

Oh great! thanks
I have that, so I guess this is separate doxygen invocation. I will look
into it. Do you happen to know where it is configured/invoked from? I would
like to add in some additional doxygen flags and regenerate.
thanks
mike


On Wed, Sep 11, 2013 at 9:25 AM, Stephan Bergmann wrote:

> On 09/11/2013 04:16 PM, James Michael DuPont wrote:
>
>> I have built the git master and ran the make docs, it produced doxygen
>> but did not produce any IDL/API docs,
>> http://api.libreoffice.org/**docs/idl/ref/servicecom_1_**
>> 1sun_1_1star_1_1text_1_**1textfield_1_1JumpEdit.html
>> this is not being generated for example, any instructions on how to
>> process the IDL?
>>
>
> Looks like "make docs" does something rather unrelated, extracting doxygen
> documentation from LO's "core" C++ files.
>
> The SDK API documentation you seek is part of the SDK product.  If you do
> a very recent master build (post this weeks instdir improvements), you find
> it at instdir/*/sdk/index.html (at least on Linux, paths differ across
> platforms) after a plain "make" (unless you configured --disable-odk).
>
> Stephan
>
>
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Michael Stahl]

On 11/09/13 16:53, James Michael DuPont wrote:
> Oh great! thanks
> I have that, so I guess this is separate doxygen invocation. I will look
> into it. Do you happen to know where it is configured/invoked from? I
> would like to add in some additional doxygen flags and regenerate.

"make odk" will generate the IDL docs, from
odk/pack/gendocu/idl/Doxyfile

... although i just got annoyed with this stupid "pack" directory
structure and moved those files on master, it's now odk/docs/idl/Doxyfile

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[bjoern]

Hi,

On Wed, Sep 11, 2013 at 05:04:01PM +0200, Michael Stahl wrote:
> On 09/09/13 10:38, Lionel Elie Mamane wrote:
> > Actually, it could make sense to document the API available in each
> > version, that is, have something like:
> > 
> > http://api.libreoffice.org/docs/3.3/idl/
> > http://api.libreoffice.org/docs/3.6/idl/
> > http://api.libreoffice.org/docs/4.0/idl/
> > http://api.libreoffice.org/docs/4.1/idl/
> > http://api.libreoffice.org/docs/4.2/idl/
> > http://api.libreoffice.org/docs/current/idl/

Well, properly packaged versions come with their own api-docs, so IMHO no need
to keep docs for unsupported releases around.

> but maybe putting in a link somewhere to the API Changes section of the
> release notes would help?

Might be a EasyHack, if somebody volunteers as a mentor: Generate XML from
doxygen, diff that and generate some fancy "API changes" report from that.

Best,

Bjoern
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[James Michael DuPont]

That is basically I am working on processing the api docs in perlmod mode
to produce python classes this could also be used for other things as well.
I would volunteer for that just need some time because of my tight schedule.


On Wed, Sep 11, 2013 at 10:54 AM, bjoern wrote:

> Hi,
>
> On Wed, Sep 11, 2013 at 05:04:01PM +0200, Michael Stahl wrote:
> > On 09/09/13 10:38, Lionel Elie Mamane wrote:
> > > Actually, it could make sense to document the API available in each
> > > version, that is, have something like:
> > >
> > > http://api.libreoffice.org/docs/3.3/idl/
> > > http://api.libreoffice.org/docs/3.6/idl/
> > > http://api.libreoffice.org/docs/4.0/idl/
> > > http://api.libreoffice.org/docs/4.1/idl/
> > > http://api.libreoffice.org/docs/4.2/idl/
> > > http://api.libreoffice.org/docs/current/idl/
>
> Well, properly packaged versions come with their own api-docs, so IMHO no
> need
> to keep docs for unsupported releases around.
>
> > but maybe putting in a link somewhere to the API Changes section of the
> > release notes would help?
>
> Might be a EasyHack, if somebody volunteers as a mentor: Generate XML from
> doxygen, diff that and generate some fancy "API changes" report from that.
>
> Best,
>
> Bjoern
> ___
> LibreOffice mailing list
> LibreOffice@lists.freedesktop.org
> http://lists.freedesktop.org/mailman/listinfo/libreoffice
>
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Lionel Elie Mamane]

On Wed, Sep 11, 2013 at 05:54:58PM +0200, bjoern wrote:
> On Wed, Sep 11, 2013 at 05:04:01PM +0200, Michael Stahl wrote:
>> On 09/09/13 10:38, Lionel Elie Mamane wrote:

>>> Actually, it could make sense to document the API available in each
>>> version, that is, have something like:

>>> http://api.libreoffice.org/docs/3.3/idl/
>>> http://api.libreoffice.org/docs/3.6/idl/
>>> http://api.libreoffice.org/docs/4.0/idl/
>>> http://api.libreoffice.org/docs/4.1/idl/
>>> http://api.libreoffice.org/docs/4.2/idl/
>>> http://api.libreoffice.org/docs/current/idl/

> Well, properly packaged versions come with their own api-docs, so
> IMHO no need to keep docs for unsupported releases around.

Packaged docs are much less practical for the user.

1) Need to install the old "packaged version" (or at least its SDK) to
   check e.g. backwards compatibility. Much easier to quickly check
   online.

2) Online docs are automatically indexed (DuckDuckGo, Google, Bing,
   ...), searchable, a general Internet search finds them, ...

-- 
Lionel
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[James Michael DuPont]

+1


On Wed, Sep 11, 2013 at 12:28 PM, Lionel Elie Mamane wrote:

>
> Packaged docs are much less practical for the user.
>
> 1) Need to install the old "packaged version" (or at least its SDK) to
>check e.g. backwards compatibility. Much easier to quickly check
>online.
>
> 2) Online docs are automatically indexed (DuckDuckGo, Google, Bing,
>...), searchable, a general Internet search finds them, ...
>
>
I agree with Lionel on this one 100%,
the fact that all the google searches for libreoffice docs are broken is
very annoying. I dont have the space or time to install all the docs or
compile all the time.
Consider the principles of open data :
http://opengovdata.io/2012-02/page/5-1-4/principles-publishing-data

u"""9. *Permanent*: Data should be made available at a stable Internet
location indefinitely. Providing documents with *permanent web
addresses*helps the public share documents with others by allowing
them to point
others directly to the authoritative source of the document, rather than
having to provide instructions on how to find it, or distributing the
document separately themselves. Permanent locations are especially useful
on government websites which are prone to being scratched and re-created as
political power shifts. """
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Stephan Bergmann]

On 09/11/2013 04:53 PM, James Michael DuPont wrote:

I have that, so I guess this is separate doxygen invocation. I will look
into it. Do you happen to know where it is configured/invoked from? I
would like to add in some additional doxygen flags and regenerate.


The doxygen input files are odk/docs/cpp/Doxyfile and 
odk/docs/idl/Doxyfile, resp.  Some "%" markers in there get replaced 
with actual values via sed in odk/CustomTarget_doxygen.mk.  "make 
odk.clean && make odk" triggers rebuilding the doxygen documentation. 
The HTML output can afterwards be found under 
workdir/*/CustomTarget/odk/docs/.


Stephan

___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Stephan Bergmann]

On 09/11/2013 07:28 PM, Lionel Elie Mamane wrote:

On Wed, Sep 11, 2013 at 05:54:58PM +0200, bjoern wrote:

On Wed, Sep 11, 2013 at 05:04:01PM +0200, Michael Stahl wrote:

On 09/09/13 10:38, Lionel Elie Mamane wrote:



Actually, it could make sense to document the API available in each
version, that is, have something like:



http://api.libreoffice.org/docs/3.3/idl/
http://api.libreoffice.org/docs/3.6/idl/
http://api.libreoffice.org/docs/4.0/idl/
http://api.libreoffice.org/docs/4.1/idl/
http://api.libreoffice.org/docs/4.2/idl/
http://api.libreoffice.org/docs/current/idl/



Well, properly packaged versions come with their own api-docs, so
IMHO no need to keep docs for unsupported releases around.


Packaged docs are much less practical for the user.


I always love it how  (linked as 
"Documentation: Manual" from the GCC homepage ) 
unambiguously makes available the documentation for each released GCC 
major.minor version.  Could serve as a model for us.


Stephan
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[James Michael DuPont]

Yes, the existing links could point to the current version and we could
host also all the older revisions as well.
mike


On Thu, Sep 12, 2013 at 3:56 AM, Stephan Bergmann wrote:

> On 09/11/2013 07:28 PM, Lionel Elie Mamane wrote:
>
>> On Wed, Sep 11, 2013 at 05:54:58PM +0200, bjoern wrote:
>>
>>> On Wed, Sep 11, 2013 at 05:04:01PM +0200, Michael Stahl wrote:
>>>
 On 09/09/13 10:38, Lionel Elie Mamane wrote:

>>>
>>  Actually, it could make sense to document the API available in each
> version, that is, have something like:
>

>>  
>> http://api.libreoffice.org/**docs/3.3/idl/
> http://api.libreoffice.org/**docs/3.6/idl/
> http://api.libreoffice.org/**docs/4.0/idl/
> http://api.libreoffice.org/**docs/4.1/idl/
> http://api.libreoffice.org/**docs/4.2/idl/
> http://api.libreoffice.org/**docs/current/idl/
>

>>  Well, properly packaged versions come with their own api-docs, so
>>> IMHO no need to keep docs for unsupported releases around.
>>>
>>
>> Packaged docs are much less practical for the user.
>>
>
> I always love it how 
> >
> (linked as "Documentation: Manual" from the GCC homepage <
> http://gcc.gnu.org/>) unambiguously makes available the documentation for
> each released GCC major.minor version.  Could serve as a model for us.
>
> Stephan
>
> __**_
> LibreOffice mailing list
> LibreOffice@lists.freedesktop.**org 
> http://lists.freedesktop.org/**mailman/listinfo/libreoffice
>
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice

Re: Please regenerate api.libreoffice.org from libreoffice-4-1 branch

[Lionel Elie Mamane]

On Thu, Sep 12, 2013 at 10:56:08AM +0200, Stephan Bergmann wrote:
> On 09/11/2013 07:28 PM, Lionel Elie Mamane wrote:

>P>ackaged docs are much less practical for the user.

> I always love it how  (linked as
> "Documentation: Manual" from the GCC homepage )
> unambiguously makes available the documentation for each released
> GCC major.minor version.  Could serve as a model for us.

PostgreSQL also makes it nicely, with links from one version to
another on each page. See
e.g. http://www.postgresql.org/docs/current/interactive/index.html

-- 
Lionel
___
LibreOffice mailing list
LibreOffice@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/libreoffice