Re: [ft-devel] Browsing API docs locally, and other updates

[Nikhil Ramakrishnan]

> This is interesting. My idea is to append a class name like "long"
> to field tables having names longer that maybe 30 characters.  Then
> I can use CSS to add specific styles to that table, so that it looks
> like what you describe.
>
> See the attached images for an idea of how these tables will look
> like. Note that other tables remain unaffected.

Very nice!  We have to check whether this is OK as a whole;

I have implemented this in docwriter with commit e113457 and this is

available on the site. Examples are:

https://www.dxdy.ooo/freetype-site/ft2-base_interface/#ft_load_xxx

https://www.dxdy.ooo/freetype-site/ft2-base_interface/#ft_fstype_xxx

I think these look OK along with the 2-column tables, because for smaller

entries, a 2 column table might be easier to read. However, for consistency,

we could also change all entries to the new definition-style list.

 

for
example it might look better if we drop the two-column layout
completely: I could imagine to consistently use

     FOO    blablablaba  bla  blubb  bla bla  blabla  blablablaba  bla
       blubb-blubb  bla  bla  blabla  blablablaba bla  blubb  bla  bla
       blablabla blablablaba bla blubb bla bla blabla blablabla blabla
       bla blubb bla bla blabla

     BAR    urgh slosh zip

or

     FOO    blablablaba bla blubb bla bla blabla blablablaba bla
       blubb-blubb bla bla blabla blablablaba bla blubb bla bla
       blablabla blablablaba bla blubb bla bla blabla blablabla blabla
       bla blubb bla bla blabla

     BAR    urgh slosh zip

or

     FOO    blablablaba  bla  blubb  bla bla  blabla  blablablaba  bla
     blubb-blubb  bla  bla  blabla   blablablaba  bla  blubb  bla  bla
     blablabla blablablaba  bla blubb bla bla  blabla blablabla blabla
     bla blubb bla bla blabla

     BAR    urgh slosh zip

or

     FOO    blablablaba bla blubb bla bla blabla blablablaba bla
     blubb-blubb bla bla blabla blablablaba bla blubb bla bla
     blablabla blablablaba bla blubb bla bla blabla blablabla blabla
     bla blubb bla bla blabla

     BAR    urgh slosh zip

Having the field name and the description next to each other may not

be as comfortable as reading a table, or a definition-style list.

Instead, we could change all entries to a definition-style list (see above).

If I understood your suggestion correctly, the attached image is a rough

idea of how it will look. IMHO we should either retain what we have now

or change all tables to the new one.

--

Nikhil

table_mod.png
Description: PNG image