Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support installing docs via *.tgz/compressed files #823

Closed
AlBannaTechno opened this issue Nov 20, 2017 · 6 comments
Closed

Support installing docs via *.tgz/compressed files #823

AlBannaTechno opened this issue Nov 20, 2017 · 6 comments

Comments

@AlBannaTechno
Copy link

AlBannaTechno commented Nov 20, 2017

Hi :
i notice : many users have a problem with downloading large docs
because zeal don't support resume-downloading or multi connection-downloading type
so i suggest to give the users the ability to add docs from compressed files
which zeal get the docs from
it's very easy you will just use extractor libs/core/extractor class to do this on specific local path
and add complete the life cycle of the operation(fetch docs) so you just will escape downloading docs step

But to be more clearness : how people will get those docs ?
I will answer 😄
There is two type of docs on kapeli/dash probject

  • 1 - docs provided with kapeli it self
    those docs we can get it with next steps
    first: go to

https://github.com/Kapeli/feeds

Then you will find all of docs provided with kapeli
so you just need to it's name
Second: use this link

http://sanfrancisco.kapeli.com/feeds/name-Of-Doc.tgz located in feeds-master.zip or https://github.com/Kapeli/feeds

For-example : to download NET_Framework docs
which NET_Framework.xml :

<entry>
    <version>4.7.0</version>
    <ios_version>1</ios_version>
    <url>http://sanfrancisco.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://london.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://newyork.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://tokyo.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://frankfurt.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://sydney.kapeli.com/feeds/NET_Framework.tgz</url>
    <url>http://singapore.kapeli.com/feeds/NET_Framework.tgz</url>
    <other-versions>
        <version><name>4.7.0</name></version>
        <version><name>4.6.2</name></version>
        <version><name>4.6.1</name></version>
    </other-versions>
</entry>

Notic You can use any mirror such:

sanfrancisco , london , newyork , tokyo , frankfurt , frankfurt ,sydney , singapore

i will use this :

http://sanfrancisco.kapeli.com/feeds/NET_Framework.tgz

  • 2 : docs contributed with users
    First fetch all user_contributed docs[names/info] from

http://sanfrancisco.kapeli.com/feeds/zzz/user_contributed/build/index.json

or any provided server of kapeli
Then fetch this specific docs as

http://<mirror>.kapeli.com/feeds/zzz/user_contributed/build/<key name inside json>/<archive name>

Most of times archive name= key name inside json.tgz

For Example if we need to download bitcoin docs
which it's data in index.json :

"Bitcoin" : { "author" : { "name" : "Jerzy Kozera", "link" : "https:\/\/github.com\/jkozera" }
we will use next link

http://newyork.kapeli.com/feeds/zzz/user_contributed/build/Bitcoin/Bitcoin.tgz

Remember You can use any mirror such:

sanfrancisco , london , newyork , tokyo , frankfurt , frankfurt ,sydney , singapore

Note : when you use this method you will not get the icon of the docs because of icon of docs not embedded in those links , method to do this was implemented in the source code of zeal

Good Luck 🌻

@trollixx
Copy link
Member

I thought it's a duplicate of #138, but no. This ticket describes how Zeal downloads docsets, so I am not sure what is actually requested. There's #430 for resuming downloads, and #170 for user contributed docsets.

@trollixx trollixx reopened this Nov 21, 2017
@trollixx
Copy link
Member

Please explain what feature are you looking for specifically.

@AlBannaTechno
Copy link
Author

AlBannaTechno commented Nov 21, 2017

i'am sorry i forget to explain this [i work with phpstorm/gfm-plugin]

i just want to add a new section to zeal:Tools/Docsets
to add new doc-set from *.tgz files & support multi-file extraction for it
the purpose of this :
1- give zeal the ability to store only data added from it /Feature request
it's mean prevent user from coping docs manually to zeal docs-dir
this will help if you will support data-base docs indexing like 'velocity'
2-give user the ability to get those docs from anywhere
either docs location is local-path or internal server/network [fetch-all-docs]
it's very generic but it's the idea
to give zeal more flexibility and Control

Thanks

@abelmul
Copy link

abelmul commented Dec 23, 2017

I think you can do this by extracting the *.tgz file in the zeal docs directory(You can find it in preferences). Except for the icon you have to download and put the icons there yourself.

@trollixx trollixx changed the title Feature request : support add docs via *.tgz/compressed files [descriped] Feature request : support add docs via *.tgz/compressed files Jan 2, 2018
@trollixx trollixx changed the title Feature request : support add docs via *.tgz/compressed files Support installing docs via *.tgz/compressed files Jan 2, 2018
@trollixx
Copy link
Member

trollixx commented Jan 2, 2018

As @abelmul mentioned, part of the problem is lack if some meta information in the archives.

This is a duplicate of #392, so please subscribe for updates.

@lock
Copy link

lock bot commented Oct 27, 2018

This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for a related request.

@lock lock bot locked and limited conversation to collaborators Oct 27, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Development

No branches or pull requests

3 participants