Thread overview | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
June 15, 2016 Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
It's a huge maintenance effort for us to produce the chm files. We no longer generate documentation on Windows, but just for the chm generation we have dedicated tools [¹] to create an index (from a json generated via ddoc) and copy the html files. So I'm wondering if in 2016 someone really needs an offline copy of a website shipped with a binary release? https://github.com/dlang/dlang.org/pull/1374 [¹]: https://github.com/dlang/dlang.org/blob/7cc6e938154f90aa49fa6451a85b13e35ab2de99/chmgen.d |
June 15, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to Martin Nowak | On 15/06/2016 10:58 PM, Martin Nowak wrote:
> It's a huge maintenance effort for us to produce the chm files.
> We no longer generate documentation on Windows, but just for the chm
> generation we have dedicated tools [¹] to create an index (from a json
> generated via ddoc) and copy the html files.
> So I'm wondering if in 2016 someone really needs an offline copy of a
> website shipped with a binary release?
>
> https://github.com/dlang/dlang.org/pull/1374
>
> [¹]:
> https://github.com/dlang/dlang.org/blob/7cc6e938154f90aa49fa6451a85b13e35ab2de99/chmgen.d
As long as pdf is still being generated I see no reason to not drop it. Cost vs benefit.
|
June 15, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to Martin Nowak | > It's a huge maintenance effort for us to produce the chm files.
>...
> So I'm wondering if in 2016 someone really needs an offline copy of a
> website shipped with a binary release?
i am very glad the chm file exists whenever i am not online, e.g. on a plane or train (free wifi is not a given everywhere). finding something in the local html is quite awkward w/o google...
if it really takes up too much time i will understand if it has to go too, especially if i a am the minority. just saying: i do use it occasionally, and whenever i do it is a big help.
/det
|
June 16, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to rikki cattermole | > As long as pdf is still being generated I see no reason to not drop it. > Cost vs benefit. not sure what pdf you are referring to. https://dlang.org/dlangspec.pdf ? - this is only the language spec. the chm contains the whole website incl phobos documentation, compiler options, articles and style guide. or is there another pdf hiding somewhere? /det |
June 16, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to captaindet | On 16/06/2016 12:04 AM, captaindet wrote:
>> As long as pdf is still being generated I see no reason to not drop it.
>> Cost vs benefit.
>
> not sure what pdf you are referring to.
> https://dlang.org/dlangspec.pdf ? - this is only the language spec. the
> chm contains the whole website incl phobos documentation, compiler
> options, articles and style guide.
>
> or is there another pdf hiding somewhere?
>
> /det
No no, spec only.
Honestly? I read the source for Phobos even with a internet connection quite often. So having it not included isn't an issue there, but spec is.
|
June 16, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to rikki cattermole | On 2016-06-16 00:29, rikki cattermole wrote:
> Honestly? I read the source for Phobos even with a internet connection
> quite often. So having it not included isn't an issue there, but spec is.
real programmers do ...
well, i do sometimes too. but i rather regard myself as an average user, while i see you as an advanced developer. ppl like me like easy digestible documentation.
i don't want to start a fight here. if it has to go it has to go. just making a point that it is useful for some.
maybe a 2nd pdf could be made instead containing the phobos docs?
|
June 16, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to captaindet | On 16/06/2016 12:57 AM, captaindet wrote: > On 2016-06-16 00:29, rikki cattermole wrote: >> Honestly? I read the source for Phobos even with a internet connection >> quite often. So having it not included isn't an issue there, but spec is. > > real programmers do ... > > well, i do sometimes too. but i rather regard myself as an average user, > while i see you as an advanced developer. ppl like me like easy > digestible documentation. I like my information easily digestible too. > i don't want to start a fight here. if it has to go it has to go. just > making a point that it is useful for some. > > maybe a 2nd pdf could be made instead containing the phobos docs? The spec is quite a problem in reading it isn't as enjoyable as say Phobos sources. That is why I mention it explicitly. But I have nothing against pdf form of Phobos docs. |
June 15, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to Martin Nowak | On Wednesday, 15 June 2016 at 10:58:04 UTC, Martin Nowak wrote:
> It's a huge maintenance effort for us to produce the chm files.
I didn't know this was a thing. It's cool, but if it is a big inconvenience, then I don't think it needs to be included. I suggest just providing a way for people to make it themselves or download it (and clearly document how to do it).
|
June 15, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to Martin Nowak | On Wednesday, 15 June 2016 at 10:58:04 UTC, Martin Nowak wrote: > It's a huge maintenance effort for us to produce the chm files. > We no longer generate documentation on Windows, but just for the chm generation we have dedicated tools [¹] to create an index (from a json generated via ddoc) and copy the html files. > So I'm wondering if in 2016 someone really needs an offline copy of a website shipped with a binary release? > > https://github.com/dlang/dlang.org/pull/1374 > > [¹]: > https://github.com/dlang/dlang.org/blob/7cc6e938154f90aa49fa6451a85b13e35ab2de99/chmgen.d Would be cool if you guys take over this and produce an official version: https://github.com/Kapeli/Dash-User-Contributions/tree/master/docsets/D Dash (and its free clone Zeal) is massively better than CHM for offline use. |
June 15, 2016 Re: Anybody still using the chm docs | ||||
---|---|---|---|---|
| ||||
Posted in reply to Martin Nowak | On Wednesday, 15 June 2016 at 10:58:04 UTC, Martin Nowak wrote:
> So I'm wondering if in 2016 someone really needs an offline copy of a website shipped with a binary release?
i use chm doc - it easy integrates with ide
|
Copyright © 1999-2021 by the D Language Foundation