New calibre help file

[unboggling]

Originally Posted by BeccaPrice

One of the reasons I love this project of mine, and why I love these forums - I learn so much! (and if I don't write it down, I forget it.)

Ditto, I do my project for the exact same reasons. That it might be of use to somebody else is a byproduct of my own learning process. With the reality check of other people commenting, to help keep the false/bad/myth info floating around to a minimum here in the MobileRead sea of information.

[BeccaPrice]

unboggling, do you have information about changing the location of your library, as in if you change computers or for some similar reason? I've noticed that it's a fairly regular question, and I'm wondering whether it should be documented somewhere that can be pointed to rather than people having to answer the same question over and over again.

My help file originally was aimed at novice users, but I've gotten a little into more complex stuff with the mobi_unpack plugin and documenting tweak books. I definitely don't want to get into regex and recipes for news downloads. I'm not sure whether changing the location of a library falls under my area or not.

[unboggling]

Originally Posted by BeccaPrice

unboggling, do you have information about changing the location of your library, as in if you change computers or for some similar reason? I've noticed that it's a fairly regular question, and I'm wondering whether it should be documented somewhere that can be pointed to rather than people having to answer the same question over and over again.

My help file originally was aimed at novice users, but I've gotten a little into more complex stuff with the mobi_unpack plugin and documenting tweak books. I definitely don't want to get into regex and recipes for news downloads. I'm not sure whether changing the location of a library falls under my area or not.

There are topics in the calibre FAQ about moving library to other computer and using the library icon to re-set calibre to point to a library at the new location, http://manual.calibre-ebook.com/faq....ter-to-another. It's the "Switch/create library" command under library icon, pointing calibre with the file browser button (to right of Location box) to an existing library. So yes, including that in help file is a good idea. I didn't go into that in "How I Manage", except possibly in relation to creating a new library.

Seems like a lot of new users also need to learn a whole bunch of other things. One thing I try to keep in mind in my own project is "what is my value added"? There is already a manual, a blog, a FAQ, a Quick Start Guide. If the user doesn't bother to read them — which I didn't the first few months, either — why will that user bother to look at my/your project? So I think it's important to focus on the value added. Which for your project, seems to me that it's a simple web-help file that is less intimidating than the FAQ, the manual, etc. If you explain more advanced topics like Tweak Books simply without confusing them, that's good. If it's too advanced or confusing you'll lose them.

There's a large distinction between "what level of ebook & calibre experience I am learning at" and "what level is my target audience at", and both of those are hard to define — for me it has been a very difficult distinction to make, which was why I changed my project to be more a map of "how I do things now".

[BeccaPrice]

I'll put on my to do list changing the location of a library, but it won't be done right away.

Just as a point of information, it took 1 hour and 41 minutes to upload my latest version of the help file (two versions, one with and one without the space in the name - I don't know which one is more useful, but Kovid pointed to the one with the space in it in his "start here" sticky, so until I hear from him that it's changed, I guess I'll have to continue to upload both versions.

[unboggling]

Originally Posted by BeccaPrice

I'll put on my to do list changing the location of a library, but it won't be done right away.

Just as a point of information, it took 1 hour and 41 minutes to upload my latest version of the help file (two versions, one with and one without the space in the name - I don't know which one is more useful, but Kovid pointed to the one with the space in it in his "start here" sticky, so until I hear from him that it's changed, I guess I'll have to continue to upload both versions.

I'd try to resolve that and return to using just one file. I'm not familiar enough with URL issues to make any suggestions. You could ask theducks or kiwidude or other mods for help resolving that space issue. Once resolved, if necessary I'm sure Kovid would change the link in his sticky.

Edit: Having re-read post #1 above, it seems the easiest resolution is to just send a private message to Kovid asking him to change the link, providing him with the url without the space.

[BeccaPrice]

Grant (kiwidude) changed it for me, so I'll only have to update one file now.

I'm taking an HTML/CSS class next term, so maybe I'll soon know better what I'm doing, at least in that arena.

[BetterRed]

@BeccaPrice, I would like to make one small suggestion, assuming its possible

Put the TOC, Index and Search buttons at the top of the 'Navigation Panel' on the left - like in the old CHM files.

Have you any thoughts of distributing as a CHM - I'm sometimes on the end of a slow and expensive satellite link.

Immediately after installing the software I watched Kovid's Getting Started video to get the basics of Calibre, its one of the best such vids I've seen.

I then went to the manual and became lost in printing and publishing jargon, a lingo with which I'm not familiar.

I run a Digital Asset Management program to manage my images, music and videos. It does not assume I am proficient in the jargon of photography, music recording or videography, nor do its competitors. But they don't do e-books too well.

BR

[BeccaPrice]

I can certainly compile it as a CHM, but web help is more transportable across operating systems. If you PM me your email, I can email a CHM to you, if you'd like. (I too am at the end of a slow and expensive satellite link, so you have my sympathy.)

I'm still learning the tool - I'll play around with the settings, see if I can get the TOC etc. buttons at the top.

Calibre is actually fairly simple to use, but the manual that comes with it is rather more technical than I am, which was the impetus for developing the help file, which is much more task-oriented than the manual is - but far less inclusive. I hope the help file will be useful for new users that way. (BR, if there's something you think I should add to the help file, let me know and I'll try to research it and include it in the next build.)

[unboggling]

Originally Posted by BeccaPrice

I'm taking an HTML/CSS class next term, so maybe I'll soon know better what I'm doing, at least in that arena.

I'm starting to learn HTML & CSS too. Trying to do it without taking formal classes through online tutorials and help files of various editor applications such as Komodo Edit. I'm thinking of buying Dreamweaver because I heard the CS6 version has some good help and templates for beginners, but it's expensive and has some pros and cons so I've been dithering.

This site has been helpful: http://webdesign.about.com

[BetterRed]

Originally Posted by BeccaPrice

I can certainly compile it as a CHM, but web help is more transportable across operating systems. If you PM me your email, I can email a CHM to you, if you'd like. (I too am at the end of a slow and expensive satellite link, so you have my sympathy.)

Aaah ha, that explains this

Originally Posted by BeccaPrice

Just as a point of information, it took 1 hour and 41 minutes to upload my latest version of the help file

Before asking for CHM I'll wait until you indicate that you've taken it as far as you want to take it. I'm only on 'drip feed' when I'm up country, in the city I have good speed. But I prefer local help because using online help is a waste of bandwidth that someone else could put to better use.

I found this the other day when I was Googling for plug-in's (a post here suggested that some plugins weren't here, and they weren't referring to Alf's). Haven't had a chance to read it - but it looks quite good - http://blog.calibre-ebook.com/

I agree Calibre is fairly simple to use, but IMO it's too dependent on knowledge of CSS, HTML etc. <sarcasm>I'm too old to learn all this new fangled declarative language stuff just to change the paper color on an EPUB.</sarcasm>

My only suggestion - and maybe its already there - is a Glossary of Terms.

BR

[Agama]

Originally Posted by BeccaPrice

go it - thanks Agama. It'll take some time (I have a hideously slow connection) but I'll upload a corrected version shortly.

That's better.

Of course, now that you have introduced Tweak Book to your help system, you may want to update the section on "Modifying an eBook's Styles", since this can be done more simply via Tweak Book. Simply edit the .css files in the exploded folder. (Maybe the two sections could be made into one.)

[unboggling]

Originally Posted by Agama

That's better.

Of course, now that you have introduced Tweak Book to your help system, you may want to update the section on "Modifying an eBook's Styles", since this can be done more simply via Tweak Book. Simply edit the .css files in the exploded folder. (Maybe the two sections could be made into one.)

… the never ending process …

[BeccaPrice]

Originally Posted by BetterRed

Before asking for CHM I'll wait until you indicate that you've taken it as far as you want to take it.

I don't know whether it'll ever be "finished" in that sense, since people add new stuff to calibre all the time.

I found this the other day when I was Googling for plug-in's (a post here suggested that some plugins weren't here, and they weren't referring to Alf's). Haven't had a chance to read it - but it looks quite good - http://blog.calibre-ebook.com/

yeah, I link to that site in the About Calibre topic - there's good stuff there, I wish they'd add more to it. Also, if you go to Dear Author and search for "calibre" you'll find lots of useful material too.

My only suggestion - and maybe its already there - is a Glossary of Terms.

I have a small glossary - what terms give you problems? I'll add them.

-becca

[BeccaPrice]

Originally Posted by Agama

That's better.

Of course, now that you have introduced Tweak Book to your help system, you may want to update the section on "Modifying an eBook's Styles", since this can be done more simply via Tweak Book. Simply edit the .css files in the exploded folder. (Maybe the two sections could be made into one.)

ok, I've added a note to the Modifying CSS topic that you can also do that through the Tweak Book menu option - there's already a link at the bottom of the topic. The note won't show up until the next upload of the help file though.

One of the strengths of calibre is that there are often multiple ways to do the same thing... but it makes it difficult to document!

[BeccaPrice]

I've just uploaded a new version. It doesn't contain much in the way of new content, only some tweaks to existing content. I've been playing with the skin, though. BetterRed, I tried getting the ToC, Index, etc. buttons to be at the top, but I felt that pushed the content in that frame way too low to be useful. I'm still experimenting, though.