Documentation formatting changes?

Discussion about the AutoHotkey Foundation and this website
Zelio
Posts: 275
Joined: 30 Sep 2013, 00:45
Location: France

Re: Documentation formatting changes?

09 May 2014, 11:08

I prefer Sidola examples (my opinion, but did you played with line-height too?), and yes Lexikos it is contradictory : high font-size make a word or a line more readable but make the page less readable, same for high line-height who make lines readable but break paragraph or other block...

However I like your example about MSDN desktop (0.875em font), it is perfect for an half screen with small content, if you want to include a tree then why not, but inside AHK docs some page have a lot of remarque and that will use too much my wheel, too far, so not very designed for a long content (or give up during search).

Other web standards http://www.google.com/ http://www.bing.com/ http://www.facebook.com/..., font and space optimized for a quick search and for habits (not for memory)... I guess that 0.8em is the best, but I can't check on mobil or big screen, but I know a lot of guy who play with body size or ctrl+wheel (big screen, blind, old...)
But it still an opinion based an my old 19" screen, an I opened some real books and checked the font size. Printing rules, do the test ! (discard child book and huge airport novel)

That reminded me a thread about Microsoft Word and Time New Roman at size 11 or 12, lol
lexikos
Posts: 6668
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Documentation formatting changes?

10 May 2014, 08:51

Is it just me or has someone reverted the online documentation?
Zelio wrote:high font-size make a word or a line more readable but make the page less readable,
I disagree. Smaller font can make searching quicker - assuming you can read the smaller font and assuming you can't just use the browser's/help viewer's built-in search.
same for high line-height who make lines readable but break paragraph or other block...
Are you inferring that the current line height is too much? I don't think it is.
that will use too much my wheel, too far
There are more efficient ways to scroll long distance.

Don't like big text? Zoom out. Or change the font settings in your browser. Personally, I think there are too many websites which ignore those settings.
Sidola wrote:- Added a gray background to each minor-header,
Why backgrounds on some headers and lines on others? Why grey? Personally, I think black on grey background is less readable. I also think the font size you have chosen is less readable. (But if text that size didn't give me eye strain after a while, I would say it's no more or less readable.)


MSDN does not use underline or backgrounds on headers, nor does it use tables for parameters in most cases. I've been using MSDN for longer than I've known about AutoHotkey, and have always found it to be effective and (for the most part) readable. My only complaint is that sometimes the font is too small.
guest3456
Posts: 2775
Joined: 09 Oct 2013, 10:31

Re: Documentation formatting changes?

10 May 2014, 17:18

lexikos wrote:Is it just me or has someone reverted the online documentation?
It certainly has changed. This is what I'm seeing now:
http://imgur.com/wrjuWF8

(which I like 100x better)

lexikos
Posts: 6668
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Documentation formatting changes?

10 May 2014, 18:28

(which I like 100x better)
And yet, the parameters still aren't in tables... :roll:
guest3456
Posts: 2775
Joined: 09 Oct 2013, 10:31

Re: Documentation formatting changes?

10 May 2014, 19:17

lol ya but the whole page is much easier to read

I would still prefer the tables, as I think they are more readable too. But I can live without

lexikos
Posts: 6668
Joined: 30 Sep 2013, 04:07
GitHub: Lexikos

Re: Documentation formatting changes?

12 May 2014, 00:53

You still don't make sense to me. My conclusion from this is that you are strange.

I have incorporated some of the suggestions from this thread. If that's not enough, tough cookies.
guest3456
Posts: 2775
Joined: 09 Oct 2013, 10:31

Re: Documentation formatting changes?

12 May 2014, 11:50

lol so be it. i guess all 5 responders in this thread are all strange simultaneously

zcooler
Posts: 455
Joined: 11 Jan 2014, 04:59

Re: Documentation formatting changes?

12 May 2014, 12:35

I was browsing some commands and didnt like the new format at all. Had to go to autohotkey.com, where the old format feels like a good friend who have taught me my first language. So many hours has been spent studying these pages and thanks to its incredible pedagogical layout, ahk is actually easy to learn. The old format is the best and well liked by so many, please dont change it!
User avatar
joedf
Posts: 7340
Joined: 29 Sep 2013, 17:08
Facebook: J0EDF
Google: +joedf
GitHub: joedf
Location: Canada
Contact:

Re: Documentation formatting changes?

12 May 2014, 19:59

Tough weird delicious cookies. :)
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500 @ 4.00 GHz, 2x8GB G.Skill RipJaws V - DDR4 3280 MHz, NVIDIA GTX 1060 6GB | [About Me] | [ASPDM - StdLib Distribution]
[Populate the AHK MiniCity!] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library] | [About the AHK Foundation]
kon
Posts: 1756
Joined: 29 Sep 2013, 17:11

Re: Documentation formatting changes?

12 May 2014, 21:48

I liked the new style, despite my nostalgia for the old docs.
I think using the same colors as the new homepage was a nice touch.
guest3456
Posts: 2775
Joined: 09 Oct 2013, 10:31

Re: Documentation formatting changes?

14 May 2014, 10:36

as if the new homepage is a design spectacle

Guest
Posts: 56
Joined: 17 Oct 2013, 02:32

Re: Documentation formatting changes?

19 May 2014, 15:25

The http://ahkscript.org/docs/Tutorial.htm page has a "home" link on the top right menu - but other doc pages don't for example http://ahkscript.org/docs/commands/WinGetText.htm

If you find a doc page via a search engine you won't be able to go to the homepage - so perhaps adding a "home" link to all pages might be a good idea.
User avatar
joedf
Posts: 7340
Joined: 29 Sep 2013, 17:08
Facebook: J0EDF
Google: +joedf
GitHub: joedf
Location: Canada
Contact:

Re: Documentation formatting changes?

20 May 2014, 18:39

Ragnars docs in German has nice a nice navigate option on the side... What if we were to put an iframe for navigation on the side?
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500 @ 4.00 GHz, 2x8GB G.Skill RipJaws V - DDR4 3280 MHz, NVIDIA GTX 1060 6GB | [About Me] | [ASPDM - StdLib Distribution]
[Populate the AHK MiniCity!] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library] | [About the AHK Foundation]
User avatar
fincs
Posts: 504
Joined: 30 Sep 2013, 14:17
GitHub: fincs
Location: Seville, Spain
Contact:

Re: Documentation formatting changes?

20 May 2014, 18:41

fincs
Windows 10 x64 Build 18362 | AMD Ryzen 7 3700X with 32 GB of RAM | AutoHotkey v1.1.31.01
Get SciTE4AutoHotkey v3.0.06.01 - [My project list]
User avatar
joedf
Posts: 7340
Joined: 29 Sep 2013, 17:08
Facebook: J0EDF
Google: +joedf
GitHub: joedf
Location: Canada
Contact:

Re: Documentation formatting changes?

20 May 2014, 18:48

Thanks fincs, yes i remember talking about this in the German forum with Ragnar.
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500 @ 4.00 GHz, 2x8GB G.Skill RipJaws V - DDR4 3280 MHz, NVIDIA GTX 1060 6GB | [About Me] | [ASPDM - StdLib Distribution]
[Populate the AHK MiniCity!] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library] | [About the AHK Foundation]
guest3456
Posts: 2775
Joined: 09 Oct 2013, 10:31

Re: Documentation formatting changes?

20 May 2014, 22:29

fincs wrote:See #95 Navigation components.
very nice.

and the <hr>s under the green headings make the doc pages much more readable (edit: actually looks like its a border-bottom but w/e)

compare
http://ahkscript.org/docs/commands/WinGetText.htm
and
https://googledrive.com/host/0Bw_Sh-zoq ... etText.htm

User avatar
joedf
Posts: 7340
Joined: 29 Sep 2013, 17:08
Facebook: J0EDF
Google: +joedf
GitHub: joedf
Location: Canada
Contact:

Re: Documentation formatting changes?

20 May 2014, 23:53

+1
Image Image Image Image Image
Windows 10 x64 Professional, Intel i5-8500 @ 4.00 GHz, 2x8GB G.Skill RipJaws V - DDR4 3280 MHz, NVIDIA GTX 1060 6GB | [About Me] | [ASPDM - StdLib Distribution]
[Populate the AHK MiniCity!] | [Qonsole - Quake-like console emulator] | [LibCon - Autohotkey Console Library] | [About the AHK Foundation]
User avatar
tank
Posts: 2774
Joined: 28 Sep 2013, 22:15
Facebook: charlie.simmons.7334
Google: ttnnkkrr
GitHub: ttnnkkrr
Location: Irving TX
Contact:

Re: Documentation formatting changes?

21 May 2014, 07:58

+1
We are troubled on every side‚ yet not distressed; we are perplexed‚
but not in despair; Persecuted‚ but not forsaken; cast down‚ but not destroyed;
https://www.facebook.com/ahkscript.org
If you have forum suggestions please submit a pull request
Check Out WebWriter
Thanks Tank :thumbup:
User avatar
xZomBie
Posts: 256
Joined: 02 Oct 2013, 02:57

Re: Documentation formatting changes?

21 May 2014, 09:34

+1 to Navigation component!
nimda
Posts: 34
Joined: 18 Dec 2013, 14:06

Re: Documentation formatting changes?

22 May 2014, 10:21

guest3456 wrote:
fincs wrote:See #95 Navigation components.
very nice.

and the <hr>s under the green headings make the doc pages much more readable (edit: actually looks like its a border-bottom but w/e)

compare
http://ahkscript.org/docs/commands/WinGetText.htm
and
https://googledrive.com/host/0Bw_Sh-zoq ... etText.htm
Oh wow, that is so much more easier to navigate. The header is separated from the rest, and the wide (long? I mean along the x axis) horizontal lines make clear visual distinctions between sections.

Return to “About This Community”

Who is online

Users browsing this forum: No registered users and 7 guests