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

Suggestions for documentation improvements #9

Open
mz-pdm opened this issue Jul 21, 2016 · 3 comments
Open

Suggestions for documentation improvements #9

mz-pdm opened this issue Jul 21, 2016 · 3 comments
Assignees

Comments

@mz-pdm
Copy link

mz-pdm commented Jul 21, 2016

First, thank you for a very nice tool! It's useful, however it's not easy to make it working, it took me a lot of time last year. Based on my experience, I suggest the following enhancements to the installation instructions:

  • org-capture Template: Mentioning the variable to modify (org-capture-templates) and adding a link to Org documentation explaining the entry would be convenient.
  • Bookmarklets: Not everyone knows what it is, so adding a few explanation words or a link into parentheses would save some web search.
  • Firefox: Adding a bookmarklet to Firefox may be non-trivial and confusing for someone who isn't familiar with that. It would be very useful to provide accurate instructions or a link to them.
  • Add protocol handler: How to add the handler when one uses neither KDE nor GNOME?
@mz-pdm
Copy link
Author

mz-pdm commented Jul 21, 2016

(If you have questions and I don't respond for long time, please send me an e-mail to [email protected] -- I've got problems with receiving notifications from GitHub.)

@alphapapa
Copy link
Owner

Hey, thanks for these suggestions. I'm not sure about the last one, because I'm not an expert on how the MIME-handling stuff works in FDO, and especially without using a desktop environment. I'm guessing LXDE and Xfce use the GNOME-based tools, but I'm not sure. With Firefox, you could add a protocol-handler entry to Firefox itself, but I don't know about Chrome or other browsers.

But the other suggestions are very doable. Thanks!

@alphapapa alphapapa self-assigned this Jul 21, 2016
@Anton-Latukha
Copy link

Coincidently my last PRs solve half of it, please make checkmarks:
#33
#34

And official docs kinda explain what is Bookmarklet. Easier to understand - it can be said: "It is a bookmark with pasted JavaScript code instead of HTTP address."

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants