Re: Documentation Workflow

2016-11-17 Thread Richard Charles 

> On Nov 17, 2016, at 12:15 PM, Carl Hoefs  
> wrote:
> 
> Fixing the layout of the documentation doesn't help the core problem, namely, 
> the way in which it's organized. Each page is so sparse as to be almost 
> worthless.

Well spoken.

> You have to drill down 2, 3, 4 or more links to find the information that you 
> want, dragging the reader through page after page…

Exactly. Drilling and dragging through the documentation is unproductive.

> Why not simply have all the relevant information on the page, where it 
> belongs?

Seems logical.

Why not have the web server detect if you are on a mobile device or on a PC. If 
you are on a mobile device (iPad or iPhone) then drilling and dragging may be 
acceptable. If you are on a PC (Mac) then please give the developer a more 
productive layout and organization of the documentation.

--Richard Charles


___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread David Brittain 
Dash for iOS has just been open sourced. It's a doc viewer for
iPad/iPhone... https://github.com/Kapeli/Dash-iOS

On 17 November 2016 at 11:23, Laurent Daudelin 
wrote:

> What’s the 2 “gist” files you are mentioning?
>
> -Laurent.
> --
> Laurent Daudelin
> laur...@nemesys-soft.com 
> AIM/iChat/Skype:LaurentDaudelin
> http://www.nemesys-soft.com/ 
> Logiciels Nemesys Software
>
> > On Nov 17, 2016, at 10:13, Slipp Douglas Thompson <
> apple+cocoa-...@slippyd.com> wrote:
> >
> > No, you don't need to know HTML or CSS to get this to work.
> >
> > Here's a basic step-by-step:
> >
> > 1. Download & install the Stylish plugin/add-on/extension for your
> browser of choice.  The official userstyles.org Stylish is available for
> Chrome ( https://chrome.google.com/webstore/detail/stylish/
> fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en ) and Firefox (
> https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), though it
> looks like someone else made a Safari version ( http://sobolev.us/stylish/
> ).
> > 2. Download the 2 files from that gist.
> > 3. Open up the Stylish plugin/add-on/extension's UI and click the import
> button, choose one file, then click import and choose the other file.
> > 4. Enjoy better layout/styling whenever you visit a URL matching
> `http[s]://developer.apple.com/reference/*`.  ;-)
> > 5 (optional). Stylish for Chrome allows you to toggle styles on & off
> for the current page by clicking the toolbar icon for the extension (to the
> right of the address bar; the Stylish extension's icon is an “S” in a
> 4-colored square), so you can decide on-the-fly if you really want to use
> these changes or not.  I'd imagine Stylish for other browsers works
> similarly.
> > 6 (optional). Modify the CSS to your liking.  The most obvious point of
> customization would be the `font-size: 10pt !important;` line— you can
> change the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical
> font size you please.
> >
> > 
> >
> > Also, I'm not sure if those images went through, so here they are again,
> hosted externally:
> >
> > Turns this: https://cl.ly/0m1c462d1z40
> > Into this: https://cl.ly/2b03340B3F2y
> >
> > — Slipp
> >
> >
> >> On Nov 17, 2016, at 8:55 AM, Richard Charles 
> wrote:
> >>
> >>
> >>> On Nov 17, 2016, at 6:45 AM, Slipp Douglas Thompson <
> apple+cocoa-...@slippyd.com> wrote:
> >>
> >> [snip]
> >>
> >>> I got tired of the layout issues and cooked up some quick Stylish CSS
> to rectify developer.apple.com/reference/* pages.
> >>
> >> [snip]
> >>
> >>> My Stylish CSS (in Mozilla Format) can be found at:
> https://gist.github.com/capnslipp/208d50e8a6c630d053b4f22e704f28a5
> >>>
> >>> — Slipp
> >>
> >> How about some simple instructions for those of us who don’t know html
> and are not web developers on how to get this to work? Do you do something
> like this?
> >>
> >> http://stackoverflow.com/questions/7173096/how-to-
> apply-default-css-styling-to-all-html-pages
> >>
> >> --Richard Charles
> >>
> >
> >
> > ___
> >
> > Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
> >
> > Please do not post admin requests or moderator comments to the list.
> > Contact the moderators at cocoa-dev-admins(at)lists.apple.com
> >
> > Help/Unsubscribe/Update your Subscription:
> > https://lists.apple.com/mailman/options/cocoa-dev/
> laurent%40nemesys-soft.com
> >
> > This email sent to laur...@nemesys-soft.com
>
> ___
>
> Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
>
> Please do not post admin requests or moderator comments to the list.
> Contact the moderators at cocoa-dev-admins(at)lists.apple.com
>
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/cocoa-dev/websites%40paperetto.com
>
> This email sent to websi...@paperetto.com
>



-- 
David Brittain
da...@paperetto.com
___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Laurent Daudelin 
What’s the 2 “gist” files you are mentioning?

-Laurent.
-- 
Laurent Daudelin
laur...@nemesys-soft.com 
AIM/iChat/Skype:LaurentDaudelin 
http://www.nemesys-soft.com/ 
Logiciels Nemesys Software

> On Nov 17, 2016, at 10:13, Slipp Douglas Thompson 
>  wrote:
> 
> No, you don't need to know HTML or CSS to get this to work.
> 
> Here's a basic step-by-step:
> 
> 1. Download & install the Stylish plugin/add-on/extension for your browser of 
> choice.  The official userstyles.org Stylish is available for Chrome ( 
> https://chrome.google.com/webstore/detail/stylish/fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en
>  ) and Firefox ( https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), 
> though it looks like someone else made a Safari version ( 
> http://sobolev.us/stylish/ ).
> 2. Download the 2 files from that gist.
> 3. Open up the Stylish plugin/add-on/extension's UI and click the import 
> button, choose one file, then click import and choose the other file.
> 4. Enjoy better layout/styling whenever you visit a URL matching 
> `http[s]://developer.apple.com/reference/*`.  ;-)
> 5 (optional). Stylish for Chrome allows you to toggle styles on & off for the 
> current page by clicking the toolbar icon for the extension (to the right of 
> the address bar; the Stylish extension's icon is an “S” in a 4-colored 
> square), so you can decide on-the-fly if you really want to use these changes 
> or not.  I'd imagine Stylish for other browsers works similarly.
> 6 (optional). Modify the CSS to your liking.  The most obvious point of 
> customization would be the `font-size: 10pt !important;` line— you can change 
> the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical font size 
> you please.
> 
> 
> 
> Also, I'm not sure if those images went through, so here they are again, 
> hosted externally:
> 
> Turns this: https://cl.ly/0m1c462d1z40
> Into this: https://cl.ly/2b03340B3F2y
> 
> — Slipp
> 
> 
>> On Nov 17, 2016, at 8:55 AM, Richard Charles  wrote:
>> 
>> 
>>> On Nov 17, 2016, at 6:45 AM, Slipp Douglas Thompson 
>>>  wrote:
>> 
>> [snip]
>> 
>>> I got tired of the layout issues and cooked up some quick Stylish CSS to 
>>> rectify developer.apple.com/reference/* pages.
>> 
>> [snip]
>> 
>>> My Stylish CSS (in Mozilla Format) can be found at: 
>>> https://gist.github.com/capnslipp/208d50e8a6c630d053b4f22e704f28a5
>>> 
>>> — Slipp
>> 
>> How about some simple instructions for those of us who don’t know html and 
>> are not web developers on how to get this to work? Do you do something like 
>> this?
>> 
>> http://stackoverflow.com/questions/7173096/how-to-apply-default-css-styling-to-all-html-pages
>> 
>> --Richard Charles
>> 
> 
> 
> ___
> 
> Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
> 
> Please do not post admin requests or moderator comments to the list.
> Contact the moderators at cocoa-dev-admins(at)lists.apple.com
> 
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/cocoa-dev/laurent%40nemesys-soft.com
> 
> This email sent to laur...@nemesys-soft.com

___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Carl Hoefs 
Fixing the layout of the documentation doesn't help the core problem, namely, 
the way in which it's organized. Each page is so sparse as to be almost 
worthless. You have to drill down 2, 3, 4 or more links to find the information 
that you want, dragging the reader through page after page...

Why not simply have all the relevant information on the page, where it belongs?

-Carl


> On Nov 17, 2016, at 8:38 AM, Alex Zavatone  wrote:
> 
> 
> On Nov 17, 2016, at 9:13 AM, Slipp Douglas Thompson wrote:
> 
>> No, you don't need to know HTML or CSS to get this to work.
>> 
>> Here's a basic step-by-step:
>> 
>> 1. Download & install the Stylish plugin/add-on/extension for your browser 
>> of choice.  The official userstyles.org Stylish is available for Chrome ( 
>> https://chrome.google.com/webstore/detail/stylish/fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en
>>  ) and Firefox ( https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), 
>> though it looks like someone else made a Safari version ( 
>> http://sobolev.us/stylish/ ).
>> 2. Download the 2 files from that gist.
>> 3. Open up the Stylish plugin/add-on/extension's UI and click the import 
>> button, choose one file, then click import and choose the other file.
>> 4. Enjoy better layout/styling whenever you visit a URL matching 
>> `http[s]://developer.apple.com/reference/*`.  ;-)
>> 5 (optional). Stylish for Chrome allows you to toggle styles on & off for 
>> the current page by clicking the toolbar icon for the extension (to the 
>> right of the address bar; the Stylish extension's icon is an “S” in a 
>> 4-colored square), so you can decide on-the-fly if you really want to use 
>> these changes or not.  I'd imagine Stylish for other browsers works 
>> similarly.
>> 6 (optional). Modify the CSS to your liking.  The most obvious point of 
>> customization would be the `font-size: 10pt !important;` line— you can 
>> change the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical 
>> font size you please.
>> 
> 
> Oh, man.  What a godsend.  No more UI that looks like it was a graphic design 
> major's "testing limits" project.
> 
> 
> 
> ___
> 
> Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
> 
> Please do not post admin requests or moderator comments to the list.
> Contact the moderators at cocoa-dev-admins(at)lists.apple.com
> 
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/cocoa-dev/newslists%40autonomy.caltech.edu
> 
> This email sent to newsli...@autonomy.caltech.edu

___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Alex Zavatone 
Adding this CSS alone increases readability dramatically for the docs pages 
when viewing from a browser. 

@namespace url(http://www.w3.org/1999/xhtml);
*{font-family:"Tahoma", sans-serif !important;}

Whatever Apple's using now looks skinny and is is simply unsettling.

Now, if we could only get rid of all that useless and excessive white space on 
the pages, you might not need a whole monitor to use for docs display.

Honestly, on the Objective-C page, there's 1/2 an inch of empty space between 
the the summary text, the horizontal gray line and then another 1/2 inch 
between the horizontal gray line and the word, "Overview".

That's a wasted inch.  And on the page I just opened, 

https://developer.apple.com/reference/objectivec?language=objc

…there is PRECISELY 3 inches of empty white space to the left of all the text 
and on the right of all text.

Whichever art school student Apple hired to set the UI standards for "UX 
Experience" is simply an idiot.

Sadly, I am so old that I remember when Apple was known for its GOOD UI design 
and user experience, not this minimalist "let's use up all the user's browser 
real estate with glaring white space.  

This is not a fine art museum where every painting needs to be framed by 5 feet 
of white space.  These are dev docs that have to present the content in an easy 
to read manner and be RESPECTFUL of the screen real estate.  It's also NICE not 
to use full white as the background for presentation, because it's glaring and 
there are still people spending all day sitting under flouresent lights in 
offices staring at their screens.  This UI is PAINFUL and causes eye fatigue.  


On Nov 17, 2016, at 10:38 AM, Alex Zavatone wrote:

> 
> On Nov 17, 2016, at 9:13 AM, Slipp Douglas Thompson wrote:
> 
>> No, you don't need to know HTML or CSS to get this to work.
>> 
>> Here's a basic step-by-step:
>> 
>> 1. Download & install the Stylish plugin/add-on/extension for your browser 
>> of choice.  The official userstyles.org Stylish is available for Chrome ( 
>> https://chrome.google.com/webstore/detail/stylish/fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en
>>  ) and Firefox ( https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), 
>> though it looks like someone else made a Safari version ( 
>> http://sobolev.us/stylish/ ).
>> 2. Download the 2 files from that gist.
>> 3. Open up the Stylish plugin/add-on/extension's UI and click the import 
>> button, choose one file, then click import and choose the other file.
>> 4. Enjoy better layout/styling whenever you visit a URL matching 
>> `http[s]://developer.apple.com/reference/*`.  ;-)
>> 5 (optional). Stylish for Chrome allows you to toggle styles on & off for 
>> the current page by clicking the toolbar icon for the extension (to the 
>> right of the address bar; the Stylish extension's icon is an “S” in a 
>> 4-colored square), so you can decide on-the-fly if you really want to use 
>> these changes or not.  I'd imagine Stylish for other browsers works 
>> similarly.
>> 6 (optional). Modify the CSS to your liking.  The most obvious point of 
>> customization would be the `font-size: 10pt !important;` line— you can 
>> change the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical 
>> font size you please.
>> 
> 
> Oh, man.  What a godsend.  No more UI that looks like it was a graphic design 
> major's "testing limits" project.
> 
> 
> 
> ___
> 
> Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
> 
> Please do not post admin requests or moderator comments to the list.
> Contact the moderators at cocoa-dev-admins(at)lists.apple.com
> 
> Help/Unsubscribe/Update your Subscription:
> https://lists.apple.com/mailman/options/cocoa-dev/zav%40mac.com
> 
> This email sent to z...@mac.com

___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Alex Zavatone 

On Nov 17, 2016, at 9:13 AM, Slipp Douglas Thompson wrote:

> No, you don't need to know HTML or CSS to get this to work.
> 
> Here's a basic step-by-step:
> 
> 1. Download & install the Stylish plugin/add-on/extension for your browser of 
> choice.  The official userstyles.org Stylish is available for Chrome ( 
> https://chrome.google.com/webstore/detail/stylish/fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en
>  ) and Firefox ( https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), 
> though it looks like someone else made a Safari version ( 
> http://sobolev.us/stylish/ ).
> 2. Download the 2 files from that gist.
> 3. Open up the Stylish plugin/add-on/extension's UI and click the import 
> button, choose one file, then click import and choose the other file.
> 4. Enjoy better layout/styling whenever you visit a URL matching 
> `http[s]://developer.apple.com/reference/*`.  ;-)
> 5 (optional). Stylish for Chrome allows you to toggle styles on & off for the 
> current page by clicking the toolbar icon for the extension (to the right of 
> the address bar; the Stylish extension's icon is an “S” in a 4-colored 
> square), so you can decide on-the-fly if you really want to use these changes 
> or not.  I'd imagine Stylish for other browsers works similarly.
> 6 (optional). Modify the CSS to your liking.  The most obvious point of 
> customization would be the `font-size: 10pt !important;` line— you can change 
> the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical font size 
> you please.
> 

Oh, man.  What a godsend.  No more UI that looks like it was a graphic design 
major's "testing limits" project.



___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Slipp Douglas Thompson 
No, you don't need to know HTML or CSS to get this to work.

Here's a basic step-by-step:

1. Download & install the Stylish plugin/add-on/extension for your browser of 
choice.  The official userstyles.org Stylish is available for Chrome ( 
https://chrome.google.com/webstore/detail/stylish/fjnbnpbmkenffdnngjfgmeleoegfcffe?hl=en
 ) and Firefox ( https://addons.mozilla.org/en-us/firefox/addon/stylish/ ), 
though it looks like someone else made a Safari version ( 
http://sobolev.us/stylish/ ).
2. Download the 2 files from that gist.
3. Open up the Stylish plugin/add-on/extension's UI and click the import 
button, choose one file, then click import and choose the other file.
4. Enjoy better layout/styling whenever you visit a URL matching 
`http[s]://developer.apple.com/reference/*`.  ;-)
5 (optional). Stylish for Chrome allows you to toggle styles on & off for the 
current page by clicking the toolbar icon for the extension (to the right of 
the address bar; the Stylish extension's icon is an “S” in a 4-colored square), 
so you can decide on-the-fly if you really want to use these changes or not.  
I'd imagine Stylish for other browsers works similarly.
6 (optional). Modify the CSS to your liking.  The most obvious point of 
customization would be the `font-size: 10pt !important;` line— you can change 
the `10pt` to `12pt` or `24pt` or `6pt` or whatever other numerical font size 
you please.



Also, I'm not sure if those images went through, so here they are again, hosted 
externally:

Turns this: https://cl.ly/0m1c462d1z40
Into this: https://cl.ly/2b03340B3F2y

— Slipp


> On Nov 17, 2016, at 8:55 AM, Richard Charles  wrote:
> 
> 
>> On Nov 17, 2016, at 6:45 AM, Slipp Douglas Thompson 
>>  wrote:
> 
> [snip]
> 
>> I got tired of the layout issues and cooked up some quick Stylish CSS to 
>> rectify developer.apple.com/reference/* pages.
> 
> [snip]
> 
>> My Stylish CSS (in Mozilla Format) can be found at: 
>> https://gist.github.com/capnslipp/208d50e8a6c630d053b4f22e704f28a5
>> 
>> — Slipp
> 
> How about some simple instructions for those of us who don’t know html and 
> are not web developers on how to get this to work? Do you do something like 
> this?
> 
> http://stackoverflow.com/questions/7173096/how-to-apply-default-css-styling-to-all-html-pages
> 
> --Richard Charles
> 


___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com

Re: Documentation Workflow

2016-11-17 Thread Richard Charles 

> On Nov 17, 2016, at 6:45 AM, Slipp Douglas Thompson 
>  wrote:

[snip]

> I got tired of the layout issues and cooked up some quick Stylish CSS to 
> rectify developer.apple.com/reference/* pages.

[snip]

> My Stylish CSS (in Mozilla Format) can be found at: 
> https://gist.github.com/capnslipp/208d50e8a6c630d053b4f22e704f28a5
> 
> — Slipp

How about some simple instructions for those of us who don’t know html and are 
not web developers on how to get this to work? Do you do something like this?

http://stackoverflow.com/questions/7173096/how-to-apply-default-css-styling-to-all-html-pages

--Richard Charles


___

Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)

Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com

Help/Unsubscribe/Update your Subscription:
https://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com

This email sent to arch...@mail-archive.com