Wanted: Volunteers to Update the Sigil User's Guide - Page 3

bershan2 · 01-16-2017, 05:47 AM

This thread had been dead for a bit more than 2 weeks now, and I'm sure something has happened in that time. Would anyone please post an update on the current state of proofreading of the latest update in the post by KevinH? Or did the manual move to a repo (which I could not find)?

I'd like to help out, but I do not want to create larger confusion, therefore so far I can work on translations on Transifex.

Hitch · 01-16-2017, 11:30 PM

Quote:

Originally Posted by bershan2

This thread had been dead for a bit more than 2 weeks now, and I'm sure something has happened in that time. Would anyone please post an update on the current state of proofreading of the latest update in the post by KevinH? Or did the manual move to a repo (which I could not find)?

I'd like to help out, but I do not want to create larger confusion, therefore so far I can work on translations on Transifex.

I'll get an update to you, if you'd like?

Hitch

Hitch · 01-21-2017, 04:05 PM

Guys:

I'm sorry to do this, but I have to postpone working on this further, for a while.

My assistant/customer service person has gone on to another gig. Her last day was Tuesday. I have not yet found a replacement for her. Our typical email load is ~220-300emails/day, and now it's just me handling it. I don't have time to eat, much less proofread. I tried not to bail on this, hoping that her replacement would beam down to my office like magic, but...not so much. I don't want to dither longer, hoping that someone will show up and I can get back to this.

I can send the File that I have on to bershan or anyone else, but I had made a number of tentative notes, in html comments, that may not be that useful to anyone but me.

Please advise; feel free to email me if you prefer.

Hitch

KevinH · 01-21-2017, 06:39 PM

Please zip up everything you have and post it to this thread here. That way everyone can find it. I'll work on getting a github site up for people to make changes to it trackable.

Thanks,

KevinH

Hitch · 01-21-2017, 07:00 PM

Quote:

Originally Posted by KevinH

Please zip up everything you have and post it to this thread here. That way everyone can find it. I'll work on getting a github site up for people to make changes to it trackable.

Thanks,

KevinH

OK. I feel terrible about it. :-(

Hitch

DiapDealer · 01-21-2017, 07:27 PM

Appreciate the attempt and the intent, Hitch. Life happens.

We'll get it all into a github repository where it belongs.

bershan2 · 01-22-2017, 03:14 PM

Looking forward to seeing the guide on GitHub.

Hitch · 01-23-2017, 03:27 AM

Quote:

Originally Posted by DiapDealer

Appreciate the attempt and the intent, Hitch. Life happens.

We'll get it all into a github repository where it belongs.

The MOMENT I have someone hired, and trained (dunno how long that will take), I have every intention of starting back up. Perhaps bershan and I can connect, and split up sections, or something.

Hitch

KevinH · 01-23-2017, 10:32 AM

When multiple people start to work on it simultaneously, I think the best best is to create a github site for the exploded (unzipped) epub materials and let people change things that way.

I would be happy to create a Sigil import plugin that will download and read the current state of the files and create an epub directly from the github site into Sigil, and an output plugin that will create a patch file against current master of any changes people want to make.

That way those without a github account or those unfamiliar with github can easily make changes.

How does that sound?

KevinH

KevinH · 01-23-2017, 10:43 AM

BTW, I would be happy to start the github site with Doitsu's version and then you can simply use the plugins (when they are ready) to make whatever changes you have already made if that would be easier.

Thanks,

KevinH

Doitsu · 01-23-2017, 12:13 PM

Quote:

Originally Posted by KevinH

BTW, I would be happy to start the github site with Doitsu's version and then you can simply use the plugins (when they are ready) to make whatever changes you have already made if that would be easier.

If you decide to check in my version, please:

1. Remove all tags with a class="deleted" attribute.
2. Remove class="new" attributes.
3. Remove the following stylesheet entries from styles.css:

Code:

.new { color: Teal; background-color: #FFFF00; }
.deleted { color: red; background-color: #FFFF00; text-decoration: line-through; }

KevinH · 01-23-2017, 12:53 PM

Hi Doitsu,

Will do.

Thanks!

KevinH

KevinH · 01-23-2017, 02:16 PM

Hi All,

I probably should change all of the .html files to .xhtml files just to make auto conversion to epub3 easier. Is that okay with people?

I noticed there was an included font SmallCaps.otf that is not obfuscated. Does anyone know if this font is free or should I be obfuscating the font and if so, with adobe or idpf obfuscation.

Thanks,

KevinH

Doitsu · 01-23-2017, 02:25 PM

Quote:

Originally Posted by KevinH

I noticed there was an included font SmallCaps.otf that is not obfuscated. Does anyone know if this font is free or should I be obfuscating the font and if so, with adobe or idpf obfuscation.

Fontin SmallCaps is a free font by Jos Buivenga that is released under a special license that allows commercial and non-commercial use.

Quote:

This font is free for personal and commercial use
The font file/software may be modified to suit design of system requirements,
but strictly for your own (personal or commercial) use. You may not sell or distribute it
Embedding (in PDF's, Flash files and programs) is allowed
You may use this font for Font-Face embedding, but only if you put a link to www.exljbris.nl on your page and/or put this notice /* A font by Jos Buivenga (exljbris) -> www.exljbris.com */ in your CSS file as near as possible to the piece of code that declares the Font-Face embedding of this font.
This font may not be distributed or sold -not online nor on any media- without my permission
This font is and remains (even when modified) the intellectual property of Jos Buivenga
exljbris Font Foundry is not liable for any damage resulting from the use of this font

KevinH · 01-23-2017, 02:30 PM

pps - possible layout of Sigil site:

I was thinking of creating a single Sigil_docs github site that would contain all of the docs in the main Sigil tree to allow easier translation and updates.

Something along the lines of:

Sigil_docs/user_guide_epub/ (with subdirectories by language code each holding the unzipped version of the epub)

Sigil_docs/plugin_framework_epub/ (ditto)

Sigil_docs/building_from_source/ (do we even need this, are translation necessary?)

That said, perhaps it would be better to create 2 different github sites:

Sigil_user_guide
Sigil_plugin_framework

and let the main Sigil github site be the location for building from source instructions since those change by distribution, toolchain, etc.

Using separate sites allows anyone can grab the zip of the master branch quite easily as each would have their own zip archive.

Comments and suggestions for how best to do this and how to handle/store translations welcome!

KevinH

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
Touch How to remove Nook User Guide and Quick Start Guide from Nook STR	umaxtuk	Barnes & Noble NOOK	17	05-22-2013 10:47 AM
Where does one find the EPUB version of the Sigil User Guide?	ubuntourist	Sigil	7	11-09-2012 11:48 PM
Sigil User Guide Not Working in IE9	TrevN	Sigil	5	09-12-2012 09:54 PM
User Guide	omar504	Amazon Kindle	5	01-27-2011 09:28 AM
Volunteers wanted `'Reseach project about Ereaders`'	UvA_research	General Discussions	39	04-01-2010 12:09 PM

01-16-2017, 05:47 AM	#31
bershan2 Junior Member Posts: 2 Karma: 10 Join Date: Jan 2017 Device: PRS-505, iPad 2, iPhone 4S, PC	This thread had been dead for a bit more than 2 weeks now, and I'm sure something has happened in that time. Would anyone please post an update on the current state of proofreading of the latest update in the post by KevinH? Or did the manual move to a repo (which I could not find)? I'd like to help out, but I do not want to create larger confusion, therefore so far I can work on translations on Transifex.

01-21-2017, 04:05 PM	#33
Hitch Bookmaker & Cat Slave Posts: 11,503 Karma: 158448243 Join Date: Apr 2010 Location: Phoenix, AZ Device: K2, iPad, KFire, PPW, Voyage, NookColor. 2 Droid, Oasis, Boox Note2	Guys: I'm sorry to do this, but I have to postpone working on this further, for a while. My assistant/customer service person has gone on to another gig. Her last day was Tuesday. I have not yet found a replacement for her. Our typical email load is ~220-300emails/day, and now it's just me handling it. I don't have time to eat, much less proofread. I tried not to bail on this, hoping that her replacement would beam down to my office like magic, but...not so much. I don't want to dither longer, hoping that someone will show up and I can get back to this. I can send the File that I have on to bershan or anyone else, but I had made a number of tentative notes, in html comments, that may not be that useful to anyone but me. Please advise; feel free to email me if you prefer. Hitch

01-21-2017, 06:39 PM	#34
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	Please zip up everything you have and post it to this thread here. That way everyone can find it. I'll work on getting a github site up for people to make changes to it trackable. Thanks, KevinH

01-21-2017, 07:27 PM	#36
DiapDealer Grand Sorcerer Posts: 28,389 Karma: 203720150 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	Appreciate the attempt and the intent, Hitch. Life happens. We'll get it all into a github repository where it belongs.

01-22-2017, 03:14 PM	#37
bershan2 Junior Member Posts: 2 Karma: 10 Join Date: Jan 2017 Device: PRS-505, iPad 2, iPhone 4S, PC	Looking forward to seeing the guide on GitHub.

01-23-2017, 10:32 AM	#39
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	When multiple people start to work on it simultaneously, I think the best best is to create a github site for the exploded (unzipped) epub materials and let people change things that way. I would be happy to create a Sigil import plugin that will download and read the current state of the files and create an epub directly from the github site into Sigil, and an output plugin that will create a patch file against current master of any changes people want to make. That way those without a github account or those unfamiliar with github can easily make changes. How does that sound? KevinH

01-23-2017, 10:43 AM	#40
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	BTW, I would be happy to start the github site with Doitsu's version and then you can simply use the plugins (when they are ready) to make whatever changes you have already made if that would be easier. Thanks, KevinH

01-23-2017, 12:53 PM	#42
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	Hi Doitsu, Will do. Thanks! KevinH

01-23-2017, 02:16 PM	#43
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	Hi All, I probably should change all of the .html files to .xhtml files just to make auto conversion to epub3 easier. Is that okay with people? I noticed there was an included font SmallCaps.otf that is not obfuscated. Does anyone know if this font is free or should I be obfuscating the font and if so, with adobe or idpf obfuscation. Thanks, KevinH

01-23-2017, 02:30 PM	#45
KevinH Sigil Developer Posts: 8,504 Karma: 5703586 Join Date: Nov 2009 Device: many	pps - possible layout of Sigil site: I was thinking of creating a single Sigil_docs github site that would contain all of the docs in the main Sigil tree to allow easier translation and updates. Something along the lines of: Sigil_docs/user_guide_epub/ (with subdirectories by language code each holding the unzipped version of the epub) Sigil_docs/plugin_framework_epub/ (ditto) Sigil_docs/building_from_source/ (do we even need this, are translation necessary?) That said, perhaps it would be better to create 2 different github sites: Sigil_user_guide Sigil_plugin_framework and let the main Sigil github site be the location for building from source instructions since those change by distribution, toolchain, etc. Using separate sites allows anyone can grab the zip of the master branch quite easily as each would have their own zip archive. Comments and suggestions for how best to do this and how to handle/store translations welcome! KevinH

Advert

Advert