3.0 Documentation - What's Needed (also - volunteers wanted)

adamsmith

There is a lot of missing documentation for the new features of 3.0
I'd like to use this thread to gather what we need and also, if possible, volunteers to take on parts of the documentation. It's a wiki and a lot of it is user generated.
Here's my first stab - please post other things below and I'll add them to the list. Also please claim items you want to work on.

1. New Word Processor Plugin - done
2. Duplicate Detection - done
3. The Website Interface
4. Standalone
a) Menu options not in Zotero (installing add-ins etc.)
b) updating other parts of the documentation for standalone - done for preferences
5. New Translator icon context menus (FF only)
6. Quick search bar improvements

Rintze

How about our jargon? Should we always use "Zotero for Firefox" for the Firefox add-on and "Zotero Standalone" for the standalone client? Can we use "LibreOffice" to refer to the LibreOffice/OpenOffice.org/NeoOffice software?

Rintze

What is the status of https://www.transifex.net/projects/p/zotero/ ? Is it operational? Can we update the documentation to point people who want to translate there?

Rintze

I think we should find a way to give more exposure to third-party software like Zandy, ZotPad and the like (especially the higher quality and open source ones). They're not plugins, and are rather hard to find in the current documentation.

fcheslack

Re transifex: not quite yet, I'm waiting for a response on a bug with their handling of mozilla DTDs. Probably we'll just work around it until a fix reaches production, but it will require some modification to the source files before people start translating.

adamsmith

How about our jargon? Should we always use "Zotero for Firefox" for the Firefox add-on and "Zotero Standalone" for the standalone client? Can we use "LibreOffice" to refer to the LibreOffice/OpenOffice.org/NeoOffice software?

yes and yes.

I think we should find a way to give more exposure to third-party software like Zandy, ZotPad and the like (especially the higher quality and open source ones). They're not plugins, and are rather hard to find in the current documentation.

Word. Any thoughts on where/how? Maybe having a link to "Using Zotero on Mobile Devices" on the quick start page? (btw. are there any non-open source apps/plugins?)

dstillman

How about our jargon? Should we always use "Zotero for Firefox" for the Firefox add-on and "Zotero Standalone" for the standalone client?

In documentation pages I've updated, I've referred to them by the full names first and then, where appropriate, shortened to "Standalone" or "Firefox" (the latter when, for example, talking about what to restart) further on in the document, since otherwise things get quite verbose.

Can we use "LibreOffice" to refer to the LibreOffice/OpenOffice.org/NeoOffice software?

Yes.

Rintze

Maybe having a link to "Using Zotero on Mobile Devices" on the quick start page?

Going a bit broader: one of the main things I think could be improved in the Zotero documentation is to make it really obvious to users what components exist in the Zotero ecosystem, help them decide which components they need/want, and help them find these. We have two versions of Zotero, a whole bunch of word processor plugins, connectors, the online Zotero libraries, styles, XUL plugins and third-party apps, and I think we can do a better job helping users to navigate all that.

A lot of this could be covered on a good landing page. E.g. http://www.zotero.org/support/installation (the first link on http://www.zotero.org/support/) is now purely focused on Zotero for Firefox, and http://www.zotero.org/support/3.0 (the target of the "Download Now" button on the front page) doesn't explain that much.

Stan

Spare a thought for the less sophisticated amongst us (like me!). With what I can find on the site, it seems like it is time to move to Zotero 3 (for example no plans to make Z2 work with FF10?) and basic instructions for the masses might help. A really detailed step by step how does one migrate from running Z2 on Firefox to Z3 - browser independent or tied to a browser? I am full of anxiety because of how important my Zotero files are. Love the idea of a stand alone app, with the library I can easily see and back up. If there is a thread telling me how to do this great but I cannot find it through the search facility. Thanks

adamsmith

We will say something about that, but it doesn't really require a step-by-step:
If you just want to upgrade to Zotero 3.0 for FF you don't need to do anything. Zotero will just upgrade itself if your on FF 10 - on older versions of FF, manually installing 3.0 from zotero.org is all you need to do to upgrade.

For Standalone: You install Standalone, tell it to share your existing Zotero library when prompted (that's also the default) and you're done. If you want to use a different browser than FF you also need to install the relevant connector (currently available for Chrome and Safari).

dstillman

Zotero will just upgrade itself if your on FF 10 - on older versions of FF, manually installing 3.0 from zotero.org is all you need to do to upgrade.

With 3.0.1 we're pushing to all users, so no manual install is necessary if you originally installed from zotero.org—Firefox will upgrade automatically (though you can speed it along if it hasn't yet done so). It'll be a bit longer before 3.0.1 is available for addons.mozilla.org users.

mronkko

This is perhaps slightly off-topic, but the download-page could include a link to a list of third-party plugins and maybe highlight a couple of the more popular and actively maintained plugins.

Particularly, I believe that there are a lot of Mac and Linux users that would find my ZoteroQuickLook plugin useful, but have not discovered it.

The reason for having these on the download-page is that that is a page that almost every user of Zotero visits.


Also, the page could include links to mobile clients ;)

adamsmith

I'd be happy to include links to Zandy, Zotpad, Zotfile and Zotero Quicklook as well as a link to the plugin page from the Download page - it's a Wiki so we could easily just do that - any objections?

dstillman

That page isn't publicly editable for security reasons.

A better download page is coming. We'll see about adding links to the third-party clients. For plugins, I think we would just link to the plugins page, which can be edited as people see fit.

fcheslack

I believe we're ready for people to start translating https://www.transifex.net/projects/p/zotero/

Gracile

Great. I've requested "the creation of a translation team for French (France)"...

bfelix

Yeeeeeeeeeeeeeeeeeeeeee

I hope it will work!

Bernadette

adamsmith

@Faolan - is there a process for declaring a translation as "done"?

fbennett

I've put up km_KH. I'll add the actual maintainer after he creates a Transifex account, but all but five or six strings are done, and it should be ready to tie into official Z.

Rintze

@fcheslack, could you set up a Translation Memory (TM) for the Transifex Zotero project?

To make sure I consistently translate certain terms I often find myself using the search box, but that is limited to the current file, and from what I understood the TM should cover the whole project.

http://help.transifex.net/intro/projects.html#setting-up-translation-memory

adamsmith

in German we've used the glossary. https://www.transifex.net/projects/p/zotero/glossary/l/de/

fcheslack

@adamsmith Not really. We can see the total percentage for each language to know when it is worth it to pull. After a translation is completed you can also switch on notifications for changes to get an email when the source strings change and the translation is no longer complete. Transifex releases don't seem to snapshot at a version of the resources, so despite my hopes it does not seem suitable for this purpose the way our translation files work.

@Rintze As far as I can tell TM is automatic within an individual project, but I think it only does fuzzy matches on entire strings rather than individual words.

Rintze

@fcheslack, yes, sorry. I indeed see TM suggestions for some strings.

Also, a comment to other translators: there are some strings that have changed over time, so it's not enough to just translate the untranslated strings.

fcheslack

There is also the reviewed flag for translations which might be useful for both completion and ensuring that no old, incorrect, or English strings got into the translations and are being ignored because they look complete. I'm not sure how translation teams would want to put those to use though (or if it is more cumbersome than helpful).

Rintze

I know that it's not Zotero 3.0-specific, but I've merged and partially rewritten http://www.zotero.org/support/collections and http://www.zotero.org/support/tags.

Every now and then discussions pop up about the benefits of each, so it seemed sensible to put everything on a single page and start out with discussing the differences between tags and collections. The screenshots (and possible screencasts) still need to be updated, but otherwise it should be good to go: http://www.zotero.org/support/collections_and_tags

adamsmith

I'll take a stab at word-processor integration in the next couple of days.

adamsmith

Proxy re-direction is also outdated
http://www.zotero.org/support/proxies

adamsmith

A first draft for Quick Format documentation is now up:
http://www.zotero.org/support/word_processor_plugin_usage
comments and/or edits very much welcome.

Also outdated:
http://www.zotero.org/support/preferences

fraenrico

I can help with the translation of the online documentation in italian. Can I get access to the editing permissions?

Gracile

@fraenrico: it's a wiki , just create an account: http://www.zotero.org/support/dev/documentation#editing_the_wiki

Rintze

I wrote a barebone entry on duplicate detection, and linked to it from the start page: http://www.zotero.org/support/duplicate_detection

Comments welcome.

[edit: I'm not a heavy user of the feature, so I wrote what I was able to quickly figure out]