September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 17:16:30 UTC, Andrei Alexandrescu wrote:
> The problem now is I need to worry about two things: class _and_ element. With div/span I only need to worry about paragraph/inline (a simpler Boolean decision) and class.
You don't need to set the class to every <dd> tag. Since all <dd> tags are direct children of a <dl> tag, you can set the class on the <dl> tag, then use a CSS child selector to specify styling. E.g.:
HTML:
<dl class="decl_ddoc">
<dt>...</dt>
<dd>...</dd>
...
CSS:
dl.decl_ddoc > dd {
/* styles that apply only to <dd>
inside a <dl class="decl_ddoc">
*/
}
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Vladimir Panteleev | On Monday, 16 September 2013 at 17:25:11 UTC, Vladimir Panteleev wrote:
> You don't need to set the class to every <dd> tag.
Yes, but since it is ddoc macros we might as well retain whatever information we can. It's only written once there, in the macro, so it isn't a big hassle anyway.
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to deadalnix | On Monday, 16 September 2013 at 04:15:43 UTC, deadalnix wrote:
> On Sunday, 15 September 2013 at 18:38:54 UTC, Sönke Ludwig wrote:
>> Am 15.09.2013 19:20, schrieb Walter Bright:
>>> On 9/15/2013 12:53 AM, Vladimir Panteleev wrote:
>>>> What happened with Ddox? This looks like an improvement in both
>>>> function and
>>>> aesthetics:
>>>>
>>>> http://vibed.org/temp/phobos/std/array.html
>>>
>>> It doesn't document the parameters, return type, and doesn't recognize
>>> embedded hyperlinks.
>>
>> Just as a reminder, this is the current version:
>> http://vibed.org/temp/d-programming-language.org/phobos/std/array.html
>
> I'm sold, that is awesome !
Me too that is much, much nicer! :D
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 14:38:25 UTC, Andrei Alexandrescu wrote: > > Which example? Are you referring to the extra spacing I added between symbols? Turns out I was looking at the wrong version. The current version here looks all right: http://vibed.org/temp/d-programming-language.org/phobos/std/array.html Though I have numerous concerns with having comments on the doc pages, and ESPECIALLY using an external service for them. -Wyatt |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to H. S. Teoh | On 9/16/13 10:07 AM, H. S. Teoh wrote: > I can attest to that. I'm on another mailing list where one of the list > members is sight-impaired, and she complains about how some websites > (i.e. those that suffer from heavy divitis and spanitis) simply can't be > read in any sane way by the screen reader. Using built-in semantic tags > like <dl> can make a world of difference for these users, since the > screen reader has no idea what class="d_decl" means, but it *does* know > what <dl> means. I wouldn't be so quick to dismiss it. OK I went back to dl/dt as shown in http://goo.gl/DzW2iI. However, when I tried to redefine DDOC_DECL_DD from DDOC_DECL_DD = $(DIVC d_decl_dd, $0) to DDOC_DECL_DD = $(DDC d_decl_dd, $0) I got bad rendering problems. What could be the matter? Is it because of nesting? Thanks, Andrei |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to H. S. Teoh | On 9/16/13 10:10 AM, H. S. Teoh wrote:
> On Mon, Sep 16, 2013 at 06:31:11PM +0200, Andrej Mitrovic wrote:
>> On 9/16/13, Andrei Alexandrescu <SeeWebsiteForEmail@erdani.org> wrote:
>>> I did it on purpose :o). I found the many adjacent underlines unsightly,
>>> and thought that "Jump to" would be evocative enough. Rollback?
>>
>> Well, it looks like one giant sentence instead of a set of links,
>> especially since some are capitalized and some are not. Perhaps
>> separate them with a bullet? E.g.:
>>
>> Appender • RefAppender • appender • array • assocArray • back...
>>
>> I don't know. :]
>
> I like the idea of delimiting with bullets.
What's a good small circular central bullet for HTML?
Andrei
|
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 17:59:11 UTC, Andrei Alexandrescu wrote: > On 9/16/13 10:10 AM, H. S. Teoh wrote: >> On Mon, Sep 16, 2013 at 06:31:11PM +0200, Andrej Mitrovic wrote: >>> On 9/16/13, Andrei Alexandrescu <SeeWebsiteForEmail@erdani.org> wrote: >>>> I did it on purpose :o). I found the many adjacent underlines unsightly, >>>> and thought that "Jump to" would be evocative enough. Rollback? >>> >>> Well, it looks like one giant sentence instead of a set of links, >>> especially since some are capitalized and some are not. Perhaps >>> separate them with a bullet? E.g.: >>> >>> Appender • RefAppender • appender • array • assocArray • back... >>> >>> I don't know. :] >> >> I like the idea of delimiting with bullets. > > What's a good small circular central bullet for HTML? > > Andrei http://www.fileformat.info/info/unicode/char/25cf/index.htm |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Sönke Ludwig | On 9/16/13 10:12 AM, Sönke Ludwig wrote: > Am 16.09.2013 12:45, schrieb Andrei Alexandrescu: >> On 9/15/13 11:34 PM, Sönke Ludwig wrote: >>> I need some form of authoritative decision on how to go about making (or >>> not making) the transition before I can start to work on the necessary >>> changes to the make file and the rest of the site. There is a suggestion >>> I made in the pull request: >>> >>> https://github.com/D-Programming-Language/dlang.org/pull/267 >> >> What other changes need to be made in addition to what's in 267 now? >> >> Andrei > > My idea was to make a proper transition from the current docs to the new > ones using a different path. Quoting from the pull: > > - Adjust the make file so that the ddox documentation goes to > "library/" and "library-prerelease/" instead of "phobos/" - leave the > original documentation there OK, preserve existing links and migrate later, nice. > - Keep the main documentation links pointed to "phobos/", but add a > small secondary link to "library/" Fine for the beginning. Guess we can pull the plug in a future small diff. > - (Optional) In the ddox documentation, add a link at the top of each > page to the corresponding old doc page Probably not worth the trouble, but always good if easy to implement for making transitioning palatable. > - Make the pull in this state Ja. > - Incorporate improvements for a while and eventually exchange the > links, making "library/" the default > > Maybe with "api" instead of "library". > > The current state is that the new docs have a separate make target that > needs to be invoked explicitly, but it will write to the same "phobos" > folder. OK great. I'll look at it soon. Andrei |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to H. S. Teoh | On 2013-09-16 16:39, H. S. Teoh wrote: > The problem is that Walter wants DDOC to be a generic macro-expansion > system. Adding any further smarts to it would tie it down to D-specific > functionality, which reduces the likelihood of it being accepted. > > But, you may be able to change his mind. :) I just want to have good documentation for D. If Walter wants to create a competitor to Markdown, sure, but don't put it in D. -- /Jacob Carlborg |
September 16, 2013 Re: Improved Phobos dox | ||||
---|---|---|---|---|
| ||||
Posted in reply to Andrei Alexandrescu | On Monday, 16 September 2013 at 17:59:11 UTC, Andrei Alexandrescu wrote:
> What's a good small circular central bullet for HTML?
·
|
Copyright © 1999-2021 by the D Language Foundation