Giter Site home page Giter Site logo

zealdocs / zeal Goto Github PK

View Code? Open in Web Editor NEW
11.0K 210.0 772.0 5.54 MB

Offline documentation browser inspired by Dash

Home Page: https://zealdocs.org

License: GNU General Public License v3.0

C++ 95.07% CSS 0.07% HTML 0.80% CMake 4.07%
documentation docset zeal docs api api-documentation dash documentation-tool developer-tools offline

zeal's People

Contributors

aboutnisblee avatar ammachado avatar azubieta avatar christoffer avatar cutewaterbeary avatar dependabot[bot] avatar drognanar avatar gekola avatar guihkx avatar henrikp avatar jightuse avatar jkozera avatar kapeli avatar michaelbeeu avatar nickcao avatar nishanthkarthik avatar pfez avatar ratijas avatar roman-kashitsyn avatar ryanwersal avatar serge45 avatar sonald avatar spacewander avatar trishume avatar trollixx avatar vbrandl avatar vtronko avatar webmaster128 avatar yiding avatar zoli avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

zeal's Issues

Windows Version and a way to limit search to particular language

First of all big congrats to your project.

Please consider a real installer for windows in two flavors.

1.Base version with no docsets.

2.Compete version with all docsets

Please provide a way to limit search to particular language or API through specific format for searching by regular expression or something.

Add support for Mozilla/vi/less-style searching through document with ‘/’ and link search with ‘'’

If you ever use less(1) or vi or Mozilla, you may appreciate being able to search a document by typing ‘/’ (forward-slash) followed by the keyword you are searching for. When I try to find in zeal, I find it uses Chrome-style C-f to initiate an in-document search. That is quite cumbersome compared to just typing a forward-slash.

If you support Mozilla-style interactive search through forward-slash, you may also consider supporting link searching through typing ‘'’ (straight single-quote) followed by the link text. If you use a Mozilla browser, you will find it convenient in many websites to reduce the number of times you much resort to using a mouse by being able to just type a single-quote and then start typing the text in the link you want to follow. This is especially common in cross-referenced documentation documents where keywords, types, or detailed member pages are linked-to. Doing a normal C-f search will not always get you to a link, but ‘'’-style searching limits the searches to links, allowing an even more optimized mouse-reduced reading/browsing experience. I am not sure if Chrome has such a feature, but if it does it doesn’t use the single-quote char, so if Chrome does have such a feature, zeal could support both chrome’s initiating keystroke sequence as well as Mozilla’s which I have described here.

ASSERT failure in QList<T>::operator[]: "index out of range",

when use https://bitbucket.org/jerzykozera/zeal-win32-binary-downloads/downloads/zeal-20131017.zip , zeal crashed.

when compile with source code, zeal also crashed.

error message:

Starting D:\Code Repository\Git\zeal\build-zeal-Desktop_Qt_5_1_1_MinGW_32bit-Debug\debug\zeal.exe...
ASSERT failure in QList<T>::operator[]: "index out of range", file C:/Qt/Qt5.1.1/5.1.1/mingw48_32/include/QtCore/qlist.h, line 460
Error - RtlWerpReportException failed with status code :-1073741696. Will try to launch the process directly

saucy ppa

Not sure if this is the best place to post this, but just upgraded to 13.10 and the ppa install instructions don't work.

W: Failed to fetch http://ppa.launchpad.net/jerzy-kozera/zeal-ppa/ubuntu/dists/saucy/main/binary-amd64/Packages  404  Not Found

Time to end the Docset Exchange

I've decided it's best if we end the docset exchange between Dash and Zeal, and just give Zeal access to all of Dash's docsets.

My reasoning is that if Zeal becomes very very popular for Windows and Linux, Dash will in turn get a few users as well. Furthermore, more users for Zeal also means that some of those users might generate docsets and hence make it better for everyone. Please note however that Dash's docsets will be available as long as Zeal does not officially support OS X and compete with Dash (which it doesn't at present).

Anyways, I've made a page which lists all of Dash's docsets with download links at http://kapeli.com/docset_links. Feel free to link to it if you want, even from inside Zeal. If appropriate, you might want to also link to http://kapeli.com/docsets somewhere (for instructions on how to generate docsets).

You can also allow Zeal to download those docsets directly. If you do that, please add a "Docsets contributed by Dash" thingy if you can.

I'll do my best to handle the hosting and bandwidth needs for Zeal too.

In the future, you might want to consider supporting Dash feeds, to allow Zeal users to receive docset updates - see http://kapeli.com/docsets#dashdocsetfeed for more details (they're really simple).

Windows Binary relies on QT libraries, fails when not installed

The Zeal binary should probably be either statically linked against the QT libraries, distribute them with the download, or provide a download link for the QT redistributables next to the windows download and mention the dependency.

(For completeness, Zeal gives "The program can't start because Qt5Core.dll is missing from your computer. Try reinstalling the program to fix the problem")

Doesn't fully install on ubuntu 12.04

Thank you so much for zeal!

So I tried ubuntu 12.04 install per directions by first adding both qt5 and zeal ppas, apt-get update and apt-get install zeal. Unfortunately it looks like just the doc is being installed.

➤ sudo find / -iname "zeal*"
[sudo] password for wrighroy:
/usr/share/doc/zeal
/var/cache/apt/archives/zeal_0.0+1snapshot201303171444+0000-1_i386.deb
/var/lib/dpkg/info/zeal.md5sums
/var/lib/dpkg/info/zeal.list

➤ cat /var/lib/dpkg/info/zeal.list
/.
/usr
/usr/share
/usr/share/doc
/usr/share/doc/zeal
/usr/share/doc/zeal/README.Debian
/usr/share/doc/zeal/changelog.Debian.gz
/usr/share/doc/zeal/copyright

➤ dpkg -s zeal
Package: zeal
Status: install ok installed
Priority: extra
Section: devel
Installed-Size: 26
Maintainer: Jerzy Kozera [email protected]
Architecture: i386
Version: 0.0+1snapshot201303171444+0000-1
Depends: libqt5gui5, libqt5webkit5, libqt5location5, libqt5quick5, libqt5qml5, libqt5sensors5, libqt5opengl5, libgstreamer0.10-0, libsqlite3-0, libgstreamer-plugins-base0.10-0, libxslt1.1, libqt5sql5-sqlite
Description: Zeal documentation browser
Zeal is a simple documentation browser inspired by Dash. It allows searching offline copies of various programming reference documentation sets.
Homepage: https://github.com/jkozera/zeal

➤ cat /etc/apt/sources.list.d/canonical-qt5-edgers-qt5-proper-precise.list
deb http://ppa.launchpad.net/canonical-qt5-edgers/qt5-proper/ubuntu precise main
deb-src http://ppa.launchpad.net/canonical-qt5-edgers/qt5-proper/ubuntu precise main

➤ cat /etc/apt/sources.list.d/jerzy-kozera-zeal-ppa-precise.list
deb http://ppa.launchpad.net/jerzy-kozera/zeal-ppa/ubuntu precise main
deb-src http://ppa.launchpad.net/jerzy-kozera/zeal-ppa/ubuntu precise main

➤ uname -a
Linux wrighroy-VirtualBox 3.5.0-25-generic #39~precise1-Ubuntu SMP Tue Feb 26 00:11:13 UTC 2013 i686 i686 i386 GNU/Linux

Closing the options modal shouldn't quit Zeal application (Windows)

At least on Windows when I click the X to close the options modal it closes the entire application in some cases.

I haven't had the opportunity to check any other platforms.

Reproduction steps

  1. Open Zeal and Options
  2. Dismiss Zeal with global hot key
  3. Close options with X on modal
  4. Use global hot key to get Zeal back
  5. Notice Zeal isn't open anymore and process isn't present in taskmgr

Can't download Android doc

After the download is complete, I can't browse through the doc at all (the doc is absent in my docset directory) and after rebooting the application Android doc disappear

Docset download timeout

I have an issue downloading docsets, the error displayed is 'Failed retreiving list of docsets: Connection timed out'. Could this be because I am connecting to the internet through a proxy?

Allow storing the docsets in any folder.

I want to use zeal in portable mode. So if I could keep the docs in any folder I like, it will be helpful. Please enhance the software to allow browsing of a docsets located anywhere on a computer.

Cannot download docset

Hi,

I cannot download docsets because i use a proxy which need authentification.
Where can i download the docsets manually ?

Thanks

Blank pages in Android docset

I downloaded the Android docsets but I can't see anything in each item.(Windows 7 64bit)
By the way, is there any ways to update the expired docsets?

Adding improved support for keyboard navigation

Zeal is now working really well for me now; it's fast, and it doesn't take up additional space. The only thing I feel a bit missing is keyboard support for navigation. I understand this would not mean much importance for such a small application, but it still makes me wish that I don't need to lift my hands off my keyboard when I'm programming.

Zeal crashes after downloading a docset.

Hello,

I've downloaded the Zeal binaries for Windows, and after I've downloaded a docset (any docset), the program crashes, and it doesn't open again until I go to the docset folder and delete everything in there. The error I'm getting is in the image I'm attaching.
zealbug

But, when I tried to compile it from the source, it worked inside Qt Creator.

I'm using Windows 8 pro x64.

segmentation fault

Hi I just got a segmentation fault when hiding zeal
what i got is

youri:~/ $ zeal                                                       [9:23:24]
QEventLoop: Cannot be used without QApplication
[1]    2803 segmentation fault (core dumped)  zeal

My hiding keybinding is alt+d.
It happens only when im on a multimonitor setup.
I'm running arch with fluxbox.
I installed qt5 specifically for using zeal.

Im not sure where I can find more info or log messages.

thanks :) great job btw.

Does not start with current version of qt5 in canonical-qt5-edgers/qt5-proper ppa

When I try to start zeal, I get the error message "Cannot mix incompatible Qt library (version 0x50001) with this library (version 0x50002)" and a "Aborted (core dumped)" (exit code 134).

Since ppas don't keep older versions, I can't even downgrade to qt 5.0.1. The canonical-qt5-edgers/qt5-proper ppa was updated 11 hours ago.

using version 0.0+1snapshot201305082353+0100-1quantal1

Unable to compile on Arch Linux

When I compile the code I get the following error

/usr/bin/ld: zip.o: undefined reference to symbol 'deflate'
/usr/bin/ld: note: 'deflate' is defined in DSO /usr/lib/libz.so.1 so try adding it to the linker command line
/usr/lib/libz.so.1: could not read symbols: Invalid operation
collect2: error: ld returned 1 exit status
make: *** [zeal] Error 1

I tried to fiddle around with the makefile by adding to the LIBS or LFLAGS but to no avail.

Code snippets

The code snippets functionality of dash is extremely attractive.

MDN will feature Zeal

Just a heads-up: MDN (Mozilla Developer Network) is conducting an experiment to see if there's actually any need for a "Read Documentation Offline" feature. As part of that experiment, they added "Read Content Offline" links to all pages, links which currently point to Dash and DocHub.

You can see the "Read Content Offline" link at https://developer.mozilla.org/en-US/docs/Web/JavaScript right below the page's title.

According to https://bugzilla.mozilla.org/show_bug.cgi?id=665750#c25, these links might/will be edited to also include Zeal.

This means that Zeal will get an increase of new users.

Zeal failed to compile on Mac

I tried to compile Zeal on OS X 10.9 with Qt5 creator, and got this error:
clang: error: invalid library name in argument '-stdlib=libc+'

Debian package or complete instructions.

A debian package for Zeal would be handy, the creation of it should be pretty similar to the Ubuntu packages you already make. I tried building it myself but got bogged down in dependencies I couldn't easily resolve.

Alternately a full list of packages needed to install before attempting to build could solve my problem.

Zeal hangs when selecting an item in the search list

I’m testing out Zeal 20130327 on x64 Windows 7. I’ve downloaded 5 docsets from Dash’s google code page and I added jQuery from the downloaded docs from within Zeal. The docsets are:

  • CSS
  • JavaScript
  • Less
  • Lo-Dash
  • NodeJS
  • UnderscoreJS

The CSS and JavaScript docsets are considerably larger, weighing in at 8.5MB and 12.1MB respectively.

Unfortunately, I’m experiencing frequent hangs of the app. It will just completely hang for ~20+ seconds, immediately after selecting an item on the left search pane for viewing. I took a full dump of the process in the middle of such a hang, which you can find here: http://altano.s3.amazonaws.com/zeal-hang-dump.zip.

I already reported this in email to Jerzy, but he said I should post here since he understandably can't promise he'll have time to look at this issue and someone else might be hitting the same bug.

If anyone can help me figure out how to compile this thing on Windows, I'd be happy to debug the problem myself. Unfortunately I'm failing at step one: I don't see a "qmake" script.

plugin system for editors

Are there bindings that could be used to develop plugins for editors? just like dash has quite a few? most interresting for me would be for sublime text

Language Option Documentation

Seria legal ter a opção de ao baixar as documentações escolher o idioma.
Por exemplo: Sou do Brasil, e quero baixar a documentação do PHP em Português.

Compile instructions should mention all dependencies

I installed the qt5-default and qt5-qmake packages and tried to compile zeal and was greeted by the following error:

Project ERROR: Unknown module(s) in QT: webkitwidgets

I wasn't expecting that I would have to install more parts of qt5. It would be nice to know if I need to download extra packages in a Debian-based distro (like Ubuntu, Linux Mint, etc.)

desktop file

It would be a good idea to provide a desktop file (see http://standards.freedesktop.org/desktop-entry-spec/latest/) for the linux distros, as most of them follow the standard.

It would make it easier to start the program, and the main zeal app (that provides the magnifying glass), wouldn't be a big ugly question mark in the DE that display the currently running apps (I only tested with Unity as of now though).

Need facility to change Hotkey

I couldn't find the way to specify a new hotkey. Now only Alt+Space is supported, and the only other option available is to clear this, which will remove Hotkey, and show none as selected. Please provide a way to specify custom Hotkey.

Zeal package dependencies

HI.

I've tried Zeal with 5.0.1 on Linux Mint 13, and it works perfectly, so can you relax the restriction on the DEB package on your PPA to be >= 5.0.0? Right now, you need to force install the package.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.