www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.announce - Revamp of CandyDOC

reply "Eldar Insafutdinov" <e.insafutdinov gmail.com> writes:
CandyDOC has not been updated for about 6 years, and despite its 
usefulness its current state was rather sad. Overall look was 
awful; colours, font sizes, everything just was not right. D 
allows some very beautiful code, but the look and feel of 
documentation is not on par. Anyway, I gave it a bit of a refresh 
(which was in fact a major refactoring) and here is an example 
http://eldar.me/candydoc/algorithm.html . Among new features is 
also instant filtering. You can grab the sources at 
https://github.com/eldar/candydoc . There is still a scope for 
improvements: adding links to the subsections and ideally 
producing links to the source code. For that ddoc needs to output 
line numbers of declarations which I am not sure it does, but 
that can be added.

Cheers

Eldar
Apr 11 2012
next sibling parent reply Andrej Mitrovic <andrej.mitrovich gmail.com> writes:
On 4/12/12, Eldar Insafutdinov <e.insafutdinov gmail.com> wrote:

 There is still a scope for
 improvements


Also: Not jumping to the Outline pane every time a different package
is selected (OR it should memorize the position of the scrollbar).
This is especially annoying in e.g. gtkd:
http://gtkd.mikewey.eu/src/cairo/Surface.html Whenever I click on
another package it jumps to the outline view, and if I go back I can't
figure out where I was because the scrollbar resets.

Othe than that your improvements look very nice!
Apr 11 2012
next sibling parent reply "Jonas Drewsen" <jdrewsen nospam.com> writes:
On Wednesday, 11 April 2012 at 22:34:40 UTC, Andrej Mitrovic 
wrote:

 On 4/12/12, Eldar Insafutdinov <e.insafutdinov gmail.com> wrote:

 There is still a scope for
 improvements


 Also: Not jumping to the Outline pane every time a different 
 package
 is selected (OR it should memorize the position of the 
 scrollbar).
 This is especially annoying in e.g. gtkd:
 http://gtkd.mikewey.eu/src/cairo/Surface.html Whenever I click 
 on
 another package it jumps to the outline view, and if I go back 
 I can't
 figure out where I was because the scrollbar resets.

 Othe than that your improvements look very nice!


The outline and package panes should be combined IMHO. Perhaps 
something like (ascii art):

---------------
+
   atk
     Component
---------------
MyClass
   getStruct
   contains
   ...
   ...
FooClass
   setBar
   ...
---------------


Where clicking on atk would show all atk packages. Clicking on + 
show all packages etc.

The lower section is simply showing the currenly selected package.

/Jonas
Apr 12 2012
next sibling parent Jordi Sayol <g.sayol yahoo.es> writes:
Al 12/04/12 22:53, En/na Jonas Drewsen ha escrit:

 
 The outline and package panes should be combined IMHO. Perhaps something like
(ascii art):
 
 ---------------
 +
   atk
     Component
 ---------------
 MyClass
   getStruct
   contains
   ...
   ...
 FooClass
   setBar
   ...
 ---------------
 
 
 Where clicking on atk would show all atk packages. Clicking on + show all
packages etc.
 
 The lower section is simply showing the currenly selected package.


I'm agree with you, but this is a deep rebuilding. First step is to separate
left pane into a single file, and this will also drastically reduce the total
size. Actually, every html package file contains all the left pane
(unnecessarily repeated).

BTW, It looks very nice now. Thanks!

Best regards,
-- 
Jordi Sayol
Apr 12 2012
prev sibling parent reply Jacob Carlborg <doob me.com> writes:
On 2012-04-12 22:53, Jonas Drewsen wrote:

 The outline and package panes should be combined IMHO. Perhaps something
 like (ascii art):

 ---------------
 +
 atk
 Component
 ---------------
 MyClass
 getStruct
 contains
 ...
 ...
 FooClass
 setBar
 ...
 ---------------


 Where clicking on atk would show all atk packages. Clicking on + show
 all packages etc.

 The lower section is simply showing the currenly selected package.

 /Jonas


That would list all packages and all symbols in the current module? I 
think the list can be quite long as it currently is. Adding all the 
packages as well will make it even longer.

-- 
/Jacob Carlborg
Apr 12 2012
parent "Jonas Drewsen" <jdrewsen nospam.com> writes:
On Friday, 13 April 2012 at 06:26:27 UTC, Jacob Carlborg wrote:

 On 2012-04-12 22:53, Jonas Drewsen wrote:

 The outline and package panes should be combined IMHO. Perhaps 
 something
 like (ascii art):

 ---------------
 +
 atk
 Component
 ---------------
 MyClass
 getStruct
 contains
 ...
 ...
 FooClass
 setBar
 ...
 ---------------


 Where clicking on atk would show all atk packages. Clicking on 
 + show
 all packages etc.

 The lower section is simply showing the currenly selected 
 package.

 /Jonas


 That would list all packages and all symbols in the current 
 module? I think the list can be quite long as it currently is. 
 Adding all the packages as well will make it even longer.


It would only list the path to the package that the current 
module is in (top part of the listview). Each package name in the 
path is clickable.

If a package name is clicked the bottom part of the listview will 
show the available modules and subpackages of that package. The 
top part is updated to show the path to the clicked package only.

If a module is clicked the its content is listed in the bottom 
part of the list and the top part of the list includes the module 
name in the path.

Since the style of D is to have flat hierarchies the top part of 
the view would probably have path with a max of three package 
names. May the can even be collapsed from:

packA
   packB
     packC

to

packA.packB.packB

in order to take up less space.

Hope it makes sense.

/Jonas
Apr 13 2012
prev sibling parent reply "Eldar Insafutdinov" <e.insafutdinov gmail.com> writes:
Hi! Thanks for the feedback, I'll have a go at fixing the 
problems. As for IE issues, I only tested it with IE9. As for the 
older IE versions, well, developers are the target users of the 
documentation. And they are usually tech savvy people so I would 
expect that they use reasonably up to date browsers. It would be 
nice if at least it functions correctly in IE8, but I don't have 
it on my machine. Is there a way to test it without installing it 
on the system(I don't want it to replace IE9 basically)?

On Wednesday, 11 April 2012 at 22:34:40 UTC, Andrej Mitrovic 
wrote:


 Also: Not jumping to the Outline pane every time a different 
 package
 is selected (OR it should memorize the position of the 
 scrollbar).
 This is especially annoying in e.g. gtkd:
 http://gtkd.mikewey.eu/src/cairo/Surface.html Whenever I click 
 on
 another package it jumps to the outline view, and if I go back 
 I can't
 figure out where I was because the scrollbar resets.



Yeah, that's annoying indeed. I will implement ajax partial 
reloading of the document content. That will preserve the state 
of the left pane.
Apr 13 2012
next sibling parent Robert Clipsham <robert octarineparrot.com> writes:
On 13/04/2012 17:41, Eldar Insafutdinov wrote:

 It would be nice if at least it functions correctly in IE8, but I
 don't have it on my machine. Is there a way to test it without
 installing it on the system(I don't want it to replace IE9
 basically)?


http://browsershots.org/ - Just check the browsers you want to test 
with. Of course it needs to be a world visible site for this to work.

(There's a select none option at the bottom after all the checkboxes)

-- 
Robert
http://octarineparrot.com/
Apr 13 2012
prev sibling next sibling parent Mirko Pilger <pilger cymotec.de> writes:
 It would be nice if at least it functions correctly in IE8, but I
 don't have it on my machine. Is there a way to test it without
 installing it on the system(I don't want it to replace IE9
 basically)?


http://utilu.com/IECollection/
Apr 13 2012
prev sibling parent Jacob Carlborg <doob me.com> writes:
On 2012-04-13 18:41, Eldar Insafutdinov wrote:

 Hi! Thanks for the feedback, I'll have a go at fixing the problems. As
 for IE issues, I only tested it with IE9. As for the older IE versions,
 well, developers are the target users of the documentation. And they are
 usually tech savvy people so I would expect that they use reasonably up
 to date browsers. It would be nice if at least it functions correctly in
 IE8, but I don't have it on my machine. Is there a way to test it
 without installing it on the system(I don't want it to replace IE9
 basically)?


Microsoft provides Virtual Box images with different version of IE 
installed:

http://www.microsoft.com/download/en/details.aspx?displaylang=en&id=11575

-- 
/Jacob Carlborg
Apr 13 2012
prev sibling next sibling parent Jordi Sayol <g.sayol yahoo.es> writes:
Al 12/04/12 00:17, En/na Eldar Insafutdinov ha escrit:

 CandyDOC has not been updated for about 6 years, and despite its usefulness
its current state was rather sad. Overall look was awful; colours, font sizes,
everything just was not right. D allows some very beautiful code, but the look
and feel of documentation is not on par. Anyway, I gave it a bit of a refresh
(which was in fact a major refactoring) and here is an example
http://eldar.me/candydoc/algorithm.html . Among new features is also instant
filtering. You can grab the sources at https://github.com/eldar/candydoc .
There is still a scope for improvements: adding links to the subsections and
ideally producing links to the source code. For that ddoc needs to output line
numbers of declarations which I am not sure it does, but that can be added.
 
 Cheers
 
 Eldar
 


Another important thing is to allow multiple directories. Lars T. Kyllingstad
has a corrected version of candydoc at https://github.com/kyllingstad/scid that
allow this.
In Your project, simply replacing "path[i]" by "path.join("_")" on
explorer.js(236), and naming html files like path_to_file.html

Best regards,
-- 
Jordi Sayol
Apr 11 2012
prev sibling next sibling parent Jacob Carlborg <doob me.com> writes:
On 2012-04-12 00:17, Eldar Insafutdinov wrote:

 CandyDOC has not been updated for about 6 years, and despite its
 usefulness its current state was rather sad. Overall look was awful;
 colours, font sizes, everything just was not right. D allows some very
 beautiful code, but the look and feel of documentation is not on par.
 Anyway, I gave it a bit of a refresh (which was in fact a major
 refactoring) and here is an example
 http://eldar.me/candydoc/algorithm.html . Among new features is also
 instant filtering. You can grab the sources at
 https://github.com/eldar/candydoc . There is still a scope for
 improvements: adding links to the subsections and ideally producing
 links to the source code. For that ddoc needs to output line numbers of
 declarations which I am not sure it does, but that can be added.

 Cheers

 Eldar


Cool.

-- 
/Jacob Carlborg
Apr 11 2012
prev sibling next sibling parent Brad Anderson <eco gnuk.net> writes:
On Wed, Apr 11, 2012 at 4:17 PM, Eldar Insafutdinov <
e.insafutdinov gmail.com> wrote:


 CandyDOC has not been updated for about 6 years, and despite its
 usefulness its current state was rather sad. Overall look was awful;
 colours, font sizes, everything just was not right. D allows some very
 beautiful code, but the look and feel of documentation is not on par.
 Anyway, I gave it a bit of a refresh (which was in fact a major
 refactoring) and here is an example http://eldar.me/candydoc/**
 algorithm.html <http://eldar.me/candydoc/algorithm.html> . Among new
 features is also instant filtering. You can grab the sources at
 https://github.com/eldar/**candydoc <https://github.com/eldar/candydoc> .
 There is still a scope for improvements: adding links to the subsections
 and ideally producing links to the source code. For that ddoc needs to
 output line numbers of declarations which I am not sure it does, but that
 can be added.

 Cheers

 Eldar


Looks really good.  Nice work.

Regards,
Brad Anderson
Apr 12 2012
prev sibling next sibling parent "a" <a a.com> writes:
This looks really nice.
Apr 12 2012
prev sibling parent reply "Jay Norwood" <jayn prismnet.com> writes:
On Wednesday, 11 April 2012 at 22:17:16 UTC, Eldar Insafutdinov 
wrote:

 example http://eldar.me/candydoc/algorithm.html . Among new



The outline panel links work fine on Google Chrome, but not on 
IE8.
Apr 12 2012
next sibling parent Jordi Sayol <g.sayol yahoo.es> writes:
Al 13/04/12 00:14, En/na Jay Norwood ha escrit:

 On Wednesday, 11 April 2012 at 22:17:16 UTC, Eldar Insafutdinov wrote:

 example http://eldar.me/candydoc/algorithm.html . Among new


 
 
 The outline panel links work fine on Google Chrome, but not on IE8.
 


Also properly works on Firefox 11 (Linux), and is a mess on IE6 on W2K.

-- 
Jordi Sayol
Apr 12 2012
prev sibling parent Ary Manzana <ary esperanto.org.ar> writes:
On 4/13/12 6:14 AM, Jay Norwood wrote:

 On Wednesday, 11 April 2012 at 22:17:16 UTC, Eldar Insafutdinov wrote:

 example http://eldar.me/candydoc/algorithm.html . Among new



 The outline panel links work fine on Google Chrome, but not on IE8.


Is there any *developer* out there using IE?
Apr 13 2012