zotero-manual / zotero-manual.github.io Goto Github PK

Can/should we delete it? I already made "gh-pages" the default branch of the repo, which should reduce accidental edits in the wrong branch.

I think it would be nice to have a diagram that shows how all the parts of the Zotero ecosystem interact (ZFF, ZSA, connectors, bookmarklet, word processor plugins, online Zotero library, Zotero data sync, Zotero file sync, WebDAV, etc.). Since there are a lot of parts, perhaps we could have a series of images that focus on different topics, e.g.

1. browsers/clients
2. bookmarklet
3. data syncing
4. file syncing
5. online library
6. word processor plugins

To show these different images, perhaps we could use a jQuery slider plugin? I found two that look nice:

http://slidesjs.com/
http://bxslider.com/

this book is great! It should be official tutorial for zotero!

This will just be a running list. Feel free to edit this post to add things.

• Bookmarklet (under install, adding items, mobile?)
  • RZ: I think we should clearly explain what the bookmarklet does early on, i.e. at the time of installation. The user needs to be able to make an informed decision between using the clients, connectors, the website, and/or the bookmarklet. The bookmarklet might deserve its own chapter, since it's not limited to mobile, and because it adds items directly to the online library (I think we should keep website and client documentation mostly separate).

It looks like nested lists are rather buggy in Maruku, the markdown parser used by GitHub Pages. See bhollis/maruku#55 and http://zotero-manual.github.io/zotero-manual/introduction#the_case_for_using_a_reference_manager (with 2 spaces, some of the <li> elements contained a <p>, which messed up the formatting; with 4 spaces, the nested lists aren't even recognized)

Some folks suggest switching to the other available parser, rdiscount. See e.g. https://github.com/phleet/blog/blob/master/_config.yml and https://groups.google.com/forum/#!topic/jekyll-rb/VbsCVo03E78

pandoc supports "Pictures with captions" (see http://johnmacfarlane.net/pandoc/demo/example9/pandocs-markdown.html ), but that won't work for GitHub Pages.

Currently I have been using
![Adding a tag in the Tags tab of an item.](screenshots/OSX-ZS-4.0.8-tag-tab.png)
but the text in this link ends up in the "alt" attribute of <img/>, which is only shown if the image can't be loaded. Somewhat better would be if we could populate the "title" attribute, which would show up as a tooltip, but I haven't found a way.

I guess we could either use straight HTML in our markdown and use the "title" attribute, or just add a caption-like description following the image, like:

![image](screenshots/OSX-ZS-4.0.8-tag-tab.png)  
**Adding a tag in the Tags tab of an item.**

(note the two spaces after the image to force a line break)

You cannot get from one chapter page to the next, you can't even get back to the homepage.

I'm using a fair amount of links in the text. We should think about how we want to handle these in a print addition of the book. Some contain very useful information, others may be a waste of space in a print work.

@rmzelle - I think it makes sense to use the issue tracker for questions like this rather than e-mail. This way everything is in one place.

Dear authors,

Thanks for your manual, this was very much needed and it rocks!
Whenever I send the link to colleagues working in natural sciences fields, I need to add things and I thought they would be better off in the manual. In particular, I would happily start to draft a section Plugins & Workflows in which plugins would be described in a more detailed manner that in zotero doc (starting with Zotfile and Better Bibtex) and typical worklows would be described in a task oriented manner, e.g.:

• how to import citations from pubmed and attach a pdf
• how to write a markdown document with zotero (Bettr Bibtex export + drag and drop / quick copy)

Please let me know if this sounds relevant to you and/or how to improve it. Of course I can also post such content somewhere else on the web if you prefer.

I'm not sure how much this will break the current markdown text. See also https://help.github.com/articles/migrating-your-pages-site-from-maruku/, http://www.growingwiththeweb.com/2014/07/my-experiences-upgrading-maruku-to-kramdown.html, and http://bloerg.net/2013/03/07/using-kramdown-instead-of-maruku.html.

The header "Chapter Contents" is included in the TOC at http://zotero-manual.github.io/zotero-manual/adding-items . I guess we could just use plain (or bold) text instead of a header.

LaTeX throws a fit about periods in filenames.
Could we change the naming convention to only include hypens as in:
Ubuntu-ZF-4-0-8-item-description.png
I can do this for all items currently in the repo