chmgen overhaul #873
chmgen overhaul #873
Conversation
|
|
||
| ---- | ||
| // ' * ' | ||
| string backSlashes(string s) |
There was a problem hiding this comment.
I went back and forth between slashes and backslashes a few times. I'm not sure which way is more compatible with the CHM readers out there.
|
Just tried to build a release from master and currently chmgen dies with an access violation. |
|
Rebased. @andralex Anything else? |
| { | ||
| if (json.type == JSON_TYPE.ARRAY) | ||
| { | ||
| auto nodes = json.array; |
Why? Why are you so concerned about the coding style of an utility that, in all likeliness, nobody except me is going to touch? Why bother if the only people who use this, use this indirectly because it's part of the build process? Why expend the effort, if we haven't heard anyone say anything about the CHM in years, likely because no one uses it any more? Why chmgen, when you have tabs all over the place elsewhere, in much more important and "trodden" parts, such as the .css files and spec .dd files and Dub and Ddox? And why now, when tabs in chmgen are nothing new, and when you know that this blocks fixing the build? Edit: The above probably sounds more dramatic than intended. I am only mildly peeved about this. |
No need to make a thing out of this. Our general guidelines avoid hard tabs, and this code is part of our repository. Please let's just do it? Thanks! |
Not the intention, it just got a little ... out of hand ... anyway, I did add a detab commit. |
|
Ping? Does anyone want to explain or talk about the problem holding up this pull, and what needs to be done to fix it? |
|
I understand that some people on Windows expect a chm help in their start menu after installation. |
|
It shouldn't look like that. I'll look into it. |
|
I'm now getting an access violation... did you not get one? |
That's not the point though, because I know you'll fix it. Since nobody looks at chm we'll always pile up regressions that we'll have to deal with before releasing, not funny. BTW |
Yeah, I know. I wanted to do it in DDoc, but... win32.mak.
Yeah, I know. I'm mostly maintaining it because Manu kept saying how important and widespread CHMs are in gamedev. |
|
BTW, by "it shouldn't look like that" I didn't mean the brokedness by itself, I mean that the navigation and sidebars should be gone, as well as the header, i.e. the content fills up the entire frame. |
I built that one manually, I'll hopefully will get one from the release builder in a few minutes. |
|
Something is really really wrong with the navigation now. |
Any comment on that @TurkeyMan? |
|
On 02/17/2015 08:21 PM, Vladimir Panteleev wrote:
|
|
Sheesh, way to out a behind-the-back-talker ;) When I maintained my old CHM page, it was relatively popular ( http://thecybershadow.net/d/docs/ ) I should add a notice that it's in D now or something I guess. |
|
The A/V was because I had an old Phobos checkout, I think. But I fixed the code too. |
Never mind, that's because I broke it. D'oh. |
Repro'd. |
|
BTW, I think IRC might be a little more efficient. And Andrei was looking for you there the other day. ;) |
|
We could create a poll on the NG, if no one uses the CHM then we can remove it. But this program would still be useful, for d.tag generation and as a lint tool. |
|
You can find my build output here. |
I'll see what I can do. Somewhere in my emacs should be an IRC client. |
Builds Digger, rabcdasm and DFeed just fine. What happened with the libcurl download link in download.dd? I was just thinking we should add an sqlite3.lib/.dll download. |
|
Oh, of course, curl.lib is included now. That leaves sqlite. |
Yep :).
As long as we don't stuff everything onto the download page again. And I don't even know how to build it. There is http://wiki.dlang.org/Curl_on_Windows, but http://wiki.dlang.org/?search=sqlite is fairly empty. Something like a build manual in the wiki and a link to ftp.digitalmars.com would work. Or better yet one could host the bins on github. |
|
The DLL download (http://www.sqlite.org/2015/sqlite-dll-win32-x86-3080802.zip) contains a .dll and a .def. |
|
SQLite is really easy to compile (as a static library, anyway) because in one of its forms it comes as a single .c file, and is compatible with DMC. |
This is still not fixed BTW, but the problem is not with chmgen. The Windows docs are built like that! |
Figured it out. You just need to force a rebuild of Druntime docs. As they're all built in Phobos' win32.mak, it can't track dependencies, so all you have to do is a clean build. |
|
@MartinNowak I still stand by that .chm claim. All gamedev docs are .chm files. It's familiar and comfortable to that industry. |
Fair enough, I'm just worried that the quality we're delivering rather turns people off and that even though we're spending quite some time on it. Maybe it would be better spend improving the pdf? |
|
Speaking for myself, I would sooner go to the internet than ever open a pdf. But if it's absorbing significant time, then I'm not sure the value holds. |
|
I say we'll keep it for now since @CyberShadow just rewrote the chmgen tool (with the nice side-effect of making dman way more useful). |
|
Eh, I enjoy working on it. I'll probably stop when the CHM stops carrying its weight (in zip filesize). |
This is close to a rewrite of chmgen:
d.tagoutput file fordmanI really wanted to do the HTML modification part with DDoc, but doing so would mean adding a few pages of copy-pasta to win32.mak (incl. a listing of Phobos modules, i.e. another unmaintainable mess). So regexes it is.
Does anyone still use the CHM documentation, anyway?