Re: A web interface for apropos: http://man-k.org/
On Wed, Apr 27, 2016 at 2:08 AM, David Young wrote: > On Sun, Apr 10, 2016 at 11:03:58PM +0530, Abhinav Upadhyay wrote: >> http://man-k.org/ >> >> I would appreciate any constructive feedback that you might have and I >> will try to implement it :-) > > This is a stylish and useful manual-page search, thank you! I have some > suggestions: Thanks David, really appreciate all the feedback :) > Conserve screen real-estate: the NetBSD logo takes up about 1/3 the > height of my browser window. That's fine when the only other thing on > the page is the search box, except possibly on small mobile screens. > Once there are search results to show, I suggest letting them fill the > available space with precedence over titles, branding, etc. Yes, I have also felt that the logo is taking too much space. I will make it smaller. > Don't paginate prematurely: if I search for "Realtek", there are only > two (short) pages of results. The first set of results (minus the logo, > title, and search box) is scarcely taller than my browser window, and > the second page is shorter. I think I could scan the entire result set > faster than I can navigate with the Next link. There's a balance to be > struck between page-load time, navigation overhead, server processing. > I'm not sure how to strike the right balance, and you have probably > given this more thought than I have, already. I am just dividing results in sets of 10, I guess I could make it 15 or 20. Performance wise it doesn't impact much. I will try experimenting after reducing the logo size. > I have a hunch that if Previous and Next buttons always appear in the > same place, with inapplicable buttons missing or "greyed out," then most > users will operate the navigation more quickly and automatically than > when Previous and Next can appear in the same location. I guess that makes sense, I didn't think about it. I will try this out. > > It's awfully convenient to have a second search box at the bottom of the > search results, since usually that is where I have scrolled if I need > to refine my query. I frequently curse Google for getting rid of the > second search box all those years ago. :-) I am pretty bad with CSS, I will try adding a search at the bottom, once I can get it to look good, I will add it :-D > BTW, I was impressed that when I searched for "an" I got the > super-relevant an(4) driver as the first result. Thank you :-), I am still trying to figure out ways to improve the relevance of the search results, I am kind of obsessed about it :-D -- Abhinav
Re: A web interface for apropos: http://man-k.org/
Would it be possible to 'center' the man page, just like the result set div? Thanks for the awesome work! : ) On Tue, Apr 26, 2016 at 5:38 PM, David Young wrote: > On Sun, Apr 10, 2016 at 11:03:58PM +0530, Abhinav Upadhyay wrote: >> http://man-k.org/ >> >> I would appreciate any constructive feedback that you might have and I >> will try to implement it :-) > > This is a stylish and useful manual-page search, thank you! I have some > suggestions: > > Conserve screen real-estate: the NetBSD logo takes up about 1/3 the > height of my browser window. That's fine when the only other thing on > the page is the search box, except possibly on small mobile screens. > Once there are search results to show, I suggest letting them fill the > available space with precedence over titles, branding, etc. > > Don't paginate prematurely: if I search for "Realtek", there are only > two (short) pages of results. The first set of results (minus the logo, > title, and search box) is scarcely taller than my browser window, and > the second page is shorter. I think I could scan the entire result set > faster than I can navigate with the Next link. There's a balance to be > struck between page-load time, navigation overhead, server processing. > I'm not sure how to strike the right balance, and you have probably > given this more thought than I have, already. > > I have a hunch that if Previous and Next buttons always appear in the > same place, with inapplicable buttons missing or "greyed out," then most > users will operate the navigation more quickly and automatically than > when Previous and Next can appear in the same location. > > It's awfully convenient to have a second search box at the bottom of the > search results, since usually that is where I have scrolled if I need > to refine my query. I frequently curse Google for getting rid of the > second search box all those years ago. :-) > > BTW, I was impressed that when I searched for "an" I got the > super-relevant an(4) driver as the first result. > > Dave > > -- > David Young > dyo...@pobox.comUrbana, IL(217) 721-9981
Re: A web interface for apropos: http://man-k.org/
On Sun, Apr 10, 2016 at 11:03:58PM +0530, Abhinav Upadhyay wrote: > http://man-k.org/ > > I would appreciate any constructive feedback that you might have and I > will try to implement it :-) This is a stylish and useful manual-page search, thank you! I have some suggestions: Conserve screen real-estate: the NetBSD logo takes up about 1/3 the height of my browser window. That's fine when the only other thing on the page is the search box, except possibly on small mobile screens. Once there are search results to show, I suggest letting them fill the available space with precedence over titles, branding, etc. Don't paginate prematurely: if I search for "Realtek", there are only two (short) pages of results. The first set of results (minus the logo, title, and search box) is scarcely taller than my browser window, and the second page is shorter. I think I could scan the entire result set faster than I can navigate with the Next link. There's a balance to be struck between page-load time, navigation overhead, server processing. I'm not sure how to strike the right balance, and you have probably given this more thought than I have, already. I have a hunch that if Previous and Next buttons always appear in the same place, with inapplicable buttons missing or "greyed out," then most users will operate the navigation more quickly and automatically than when Previous and Next can appear in the same location. It's awfully convenient to have a second search box at the bottom of the search results, since usually that is where I have scrolled if I need to refine my query. I frequently curse Google for getting rid of the second search box all those years ago. :-) BTW, I was impressed that when I searched for "an" I got the super-relevant an(4) driver as the first result. Dave -- David Young dyo...@pobox.comUrbana, IL(217) 721-9981
Re: A web interface for apropos: http://man-k.org/
On Mon, Apr 18, 2016 at 11:31 PM, Abhinav Upadhyay wrote: > On Mon, Apr 11, 2016 at 12:02 AM, Mindaugas Rasiukevicius > wrote: >> Abhinav Upadhyay wrote: >>> Recently, I have been working on building a web interface for >>> apropos(1). Although, there are still plenty of things to do but I >>> think it is in a decent shape now and I wanted to share it with all of >>> you. >>> >>> http://man-k.org/ >>> >>> I would appreciate any constructive feedback that you might have and I >>> will try to implement it :-) >> >> That is convenient. Would you be able to add POSIX manuals? >> >> https://www.kernel.org/pub/linux/docs/man-pages/man-pages-posix/ >> >> Other systems would be handy too, e.g. illumos and some Linux distribution. > > Just pushed support for searching posix man pages: > http://man-k.org/posix/ > > For searching NetBSD man pages goto http://man-k.org/ or > http://man-k.org/netbsd > Let me know if you find any issues :) Just wanted to give a couple of updates: 1. HTTPS is the default now :) 2. I have added linux man pages as well at https://man-k.org/linux/ -- Abhinav
Re: A web interface for apropos: http://man-k.org/
On Mon, Apr 11, 2016 at 12:02 AM, Mindaugas Rasiukevicius wrote: > Abhinav Upadhyay wrote: >> Recently, I have been working on building a web interface for >> apropos(1). Although, there are still plenty of things to do but I >> think it is in a decent shape now and I wanted to share it with all of >> you. >> >> http://man-k.org/ >> >> I would appreciate any constructive feedback that you might have and I >> will try to implement it :-) > > That is convenient. Would you be able to add POSIX manuals? > > https://www.kernel.org/pub/linux/docs/man-pages/man-pages-posix/ > > Other systems would be handy too, e.g. illumos and some Linux distribution. Just pushed support for searching posix man pages: http://man-k.org/posix/ For searching NetBSD man pages goto http://man-k.org/ or http://man-k.org/netbsd Let me know if you find any issues :) -- Abhinav
Re: A web interface for apropos: http://man-k.org/
On Mon, Apr 11, 2016 at 6:28 AM, Niels Dettenbach wrote: > Is this code open source or similiar? This would allow us to provide further > docs for our NetBSD "guest" machines in out intranet etc... https://github.com/abhinav-upadhyay/apropos_web
Re: A web interface for apropos: http://man-k.org/
On Mon, Apr 11, 2016 at 2:58 PM, Niels Dettenbach wrote: > Am Sonntag, 10. April 2016, 23:03:58 schrieben Sie: >> http://man-k.org/ > > cool! > > ...hit just a small bug: > > http://man-k.org/search?q=dmidecode Thanks for letting me know about it. It's part of a bigger bug, but I fixed it for now :) > (just a shot in the dark - i6 seems really non existing strings are not a > problem Yes. It was a corner case and the JSON output was not proper. > - some simple backlinks to the main page / "back" would be nice Although, every page has the search input box, so I thought the back link was probably not necessary. But I have been thinking, I could probably link the NetBSD logo to the home page. > very nice work so far. Thank you :) > Is this code open source or similiar? This would allow us to provide further > docs for our NetBSD "guest" machines in out intranet etc... It is open source: https://github.com/abhinav-upadhyay/apropos_web (that is the web layer). It calls the NetBSD apropos(1) to do the actual search. I have made changes in apropos(1) to give me JSON output. These changes are not part of NetBSD's apropos(1) code yet and that means you cannot run it out of the box. The changes I have made to apropos are available in my github repo: https://github.com/abhinav-upadhyay/apropos_replacement, in the merge_netbsd_linux branch (I have made few changes to make it compile on Linux as well, thus the branch name). Let me know, if you are interested in setting it up locally, I can provide detailed instructions. :) -- Abhinav
Re: A web interface for apropos: http://man-k.org/
Am Sonntag, 10. April 2016, 23:03:58 schrieben Sie: > http://man-k.org/ cool! ...hit just a small bug: http://man-k.org/search?q=dmidecode (just a shot in the dark - i6 seems really non existing strings are not a problem - some simple backlinks to the main page / "back" would be nice very nice work so far. Is this code open source or similiar? This would allow us to provide further docs for our NetBSD "guest" machines in out intranet etc... cheerioh, Niels. -- --- Niels Dettenbach Syndicat IT & Internet http://www.syndicat.com PGP: https://syndicat.com/pub_key.asc --- signature.asc Description: This is a digitally signed message part.
Re: A web interface for apropos: http://man-k.org/
-BEGIN PGP SIGNED MESSAGE- Hash: SHA256 On 10.04.2016 19:42, Abhinav Upadhyay wrote: > Thanks, I'm glad you find it useful :). > > And thanks for the pointer for netbsd-users, too. I will post a > note there as well. > > -- Abhinav > > On Sun, Apr 10, 2016 at 11:09 PM, wrote: >> Thanks for that! I'll definitely use it. >> >> (btw, the typical user list is netbsd-users) Thank you! I'm glad to see this page, I will definitely use and recommend it. -BEGIN PGP SIGNATURE- Version: GnuPG v2 iQIcBAEBCAAGBQJXCrlBAAoJEEuzCOmwLnZsqcMP/3sVTS3NkUujN13PltRzdHlH Ty/4YZWpOu0MFwjiGXZebdWLKY7Hd+GLoX8W6Dh8Uxhp8g0hTaNk2R5sHb/xNorP 2SYQyB2f3O/0ULyzpkLw1j3qH5Qhkcp+HeuN3H7MYCl35lA3jomYg5PIL9gMROdY vKt4dnFLTQUPG3MGx9gGeIvA4sw5U5855r1N07pSyRL2pV+zyuBogtByyk7Erf6R iS4rBxUpUF+PNrX0rk0CGlnYp0Z8F94/sL1sP8kielTqZoTYHV6ZNVDMUAriCg9C AHTeMf8xTn3ABEuic9vMw+j6XD2r7gLR10ZogCGyQjjXQSfUBpJFBdH6d6OsmnxN fA6jz8O0XvOUOeyTkk/cnDvZ/GVHIRDdJvS0kvzWiYXxdn2zL2mdqVnEisP9ZqxN VFoprXOwKzyh1B8kcPQMWnVTewtXAm2/QfkXZH33+0jkNKY3BpJFbxep8bum5lPA OZ+CQWhzsSZlDr8vG2lKnP+Pqf40oXhWeQ4uuUR9Kwx54nTkc2BlRIhWiA7DIcNB 3ZCXJMwf5E0Qdd4CyXmdvkIkpKAdMIEy+rWUvrDiViDwclMPIIxYjqFHz2MrxrOv hF/x7IixyHlyJwD5LyxfonBxxNR37gZHZFgpqpqUReRjhmMS8Sm7UvMiQRb4BmB5 Y5DBsx67qqWeF9c9BJUY =gOBO -END PGP SIGNATURE-
Re: A web interface for apropos: http://man-k.org/
On Mon, Apr 11, 2016 at 12:02 AM, Mindaugas Rasiukevicius wrote: > Abhinav Upadhyay wrote: >> Recently, I have been working on building a web interface for >> apropos(1). Although, there are still plenty of things to do but I >> think it is in a decent shape now and I wanted to share it with all of >> you. >> >> http://man-k.org/ >> >> I would appreciate any constructive feedback that you might have and I >> will try to implement it :-) > > That is convenient. Would you be able to add POSIX manuals? > > https://www.kernel.org/pub/linux/docs/man-pages/man-pages-posix/ > > Other systems would be handy too, e.g. illumos and some Linux distribution. Thanks. It should be possible to add the POSIX manuals, I will try and add them. Other systems' manual are tricky, there will be duplicates clashing with man pages from NetBSD. I need to figure out a way to specify the OS in the query perhaps. -- Abhinav
Re: A web interface for apropos: http://man-k.org/
Abhinav Upadhyay wrote: > Recently, I have been working on building a web interface for > apropos(1). Although, there are still plenty of things to do but I > think it is in a decent shape now and I wanted to share it with all of > you. > > http://man-k.org/ > > I would appreciate any constructive feedback that you might have and I > will try to implement it :-) That is convenient. Would you be able to add POSIX manuals? https://www.kernel.org/pub/linux/docs/man-pages/man-pages-posix/ Other systems would be handy too, e.g. illumos and some Linux distribution. -- Mindaugas
Re: A web interface for apropos: http://man-k.org/
Thanks, I'm glad you find it useful :). And thanks for the pointer for netbsd-users, too. I will post a note there as well. -- Abhinav On Sun, Apr 10, 2016 at 11:09 PM, wrote: > Thanks for that! I'll definitely use it. > > (btw, the typical user list is netbsd-users)
Re: A web interface for apropos: http://man-k.org/
Thanks for that! I'll definitely use it. (btw, the typical user list is netbsd-users)
A web interface for apropos: http://man-k.org/
Hi All, Sorry, for cross posting. Recently, I have been working on building a web interface for apropos(1). Although, there are still plenty of things to do but I think it is in a decent shape now and I wanted to share it with all of you. http://man-k.org/ I would appreciate any constructive feedback that you might have and I will try to implement it :-) -- Abhinav
