Git Product home page Git Product logo

sigil-user-guide's Introduction

This is the repository for the Sigil User Guide


Guidelines for contributing


  1. NO ARTISTIC/AESTHETIC CHANGES PLEASE! We're only interested in content updates and corrections, or updated screenshots that show new menus or new features. If you're hoping to "jazz things up" or redo the the style of the epub to reflect your personal style or formatting preferences, you're probably going to be disappointed. Pull Requests that include stylistic changes or "upgrades" will be declined (unless such work has been pre-approved of course).

  2. Less is best. Several smaller, tightly focused Pull Requests are always going to be preferred over ones that represent grand, sweeping changes to large swathes of the manual. We don't want to have to read the entire manual each and every time we're evaluating a new Pull Request. Neither would you. Be considerate if you want to see your efforts incorporated.

  3. Don't Break anything. Changes that break the resulting epub or cause validation issues will be rejected. It's your responsibility to make sure the epub structure remains intact and spec compliant.



Preferred Workflow


  • Fork this repository to your own Github account and clone a local copy of it to your computer.

  • Use the FolderIn Sigil plugin to load the contents of the "src" directory of your local, cloned repository into Sigil.

  • Do your editing (saving changes to a local temporary epub somewhere if you must). Remember to use "Mend and Prettify" after you're done, and always make sure the epub validates with no errors. Then when ready, save the contents back to the "src" directory of your local, cloned repository using the FolderOut Sigil plugin.

  • Use the normal git tools to check your differences and then when satisfied, commit and push your changes to your Github fork.

  • Create a new Pull Request from your Github account so that we can review and hopefully pull your changes into the project.




If you run into trouble, feel free to ask for help at the Sigil Support forums on Mobileread.

sigil-user-guide's People

Contributors

beckydtp avatar dougmassay avatar gr8kodr avatar kevinhendricks avatar mizuoda avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

sigil-user-guide's Issues

Can't save

Suddenly having several issues. What does this mean:
Error info: Cannot save file C:/Users/Jim Henry/AppData/Local/Packages/microsoft.windowscommunicationsapps_8wekyb3d8bbwe/LocalState/Files/S0/10/Attachments/A Right where you're supposed to be - Ran Register[165].epub: C:/Users/Jim Henry/AppData/Local/Packages/microsoft.windowscommunicationsapps_8wekyb3d8bbwe/LocalState/Files/S0/10/Attachments/A Right where you're supposed to be - Ran Register[165].epub
Sigil version: 1.4.3
Runtime Qt: 5.12.9
Compiled Qt: 5.12.9
System: Windows 10 (10.0)
Architecture: x86_64

I think that these are inaccuracies and typos.

Hello.

Finished the translation of the chapter "Tutorials" from the Guide.
Along the way, I compiled a list that included, as I think, various inaccuracies and typos. See for yourself:

File: about_epub.xhtml
extra closing bracket
Your EPUB stores your words and text in the book using the an XML form called XHTML of the HTML format (Hyper Text Markup Language) – the same code used by web pages to display text and images).

TUTORIAL

File: tutorial_getting_started_with_epub.xhtml
probably Right-To-Left
EPUB3 EPUBs are quickly becoming the international publishing standard as they support both Right-To_Left (RTL) and Left-To_Right (LTR) text layout,

File: tutorial_embed_fonts.xhtml
no closing quote in title
@font-face {
font-family: 'Garamond ;

File: tutorial_save.xhtml
extra colon after File=>Save:

To save your EPUB, click the Save icon Showing File Save icon. or use the menu item File=>Save: or the keyboard shortcut – Ctrl+S [1]

File: tutorial_load_file.xhtml
extra colon after File=>Open:

To load your HTML or EPUB file into Sigil, click the Open icon File Open menu or use the menu item File=>Open: or the keyboard shortcut Ctrl+O

File: tutorial_add_cover.xhtml
double tag

To add a cover, just select the menu item Tools=>Add Cover

in these paragraphs, swap the colon and period at the end of sentences

And that’s it. Sigil has added your image to the EPUB and marked it as the cover image. It has also created an HTML file at the start of your book and inserted your cover image into the file so that it will be displayed at the start of the book:

The contents of your Book Browser show that the cover.xhtml file has been added to the Text folder, and the cover.jpg image has been added to the Images folder.

File: tutorial_mark_chapters.xhtml
a colon at the end of a paragraph instead of a period

In order to create a Table of Contents you need to tell Sigil what your chapter names are. To do this just select each chapter name in your book and use one of the toolbar buttons to mark it as a chapter heading:

File: tutorial_spelling.xhtml
instead of Case-Insensitive Sort it should be Locale-Aware Sort or this line refers to another topic altogether

  • Case-Insensitive Sort: Enable this to sort words as AaBbCc instead of ABCabc.
  • File: tutorial_find_replace.xhtml
    different words are used in the examples on the pictures in the section "Using Find & Replace"

    File: tutorial_advanced_find.xhtml
    in the tutorial-find-regex-chapter.png picture, the mode is "Normal" instead of "Regex"

    Add info on ShortCut keys being remapped on macOS to User Interface chapter

    This is a reminder to myself to add info about ShortCut keys being remapped by Qt just on MacOS to our Sigil User's manual.

    Something like quoting the following from Qt. Possibly in an aside (box).

    Note: On macOS, references to "Ctrl", Qt::CTRL, Qt::Key_Control 
    and Qt::ControlModifier correspond to the Command keys on the 
    Macintosh keyboard, and references to "Meta", Qt::META, 
    Qt::Key_Meta and Qt::MetaModifier correspond to the Control keys.
    

    Then add something like:

    Using this convention allows each platform's most common shortcut 
    key sequences to work as expected.  For example,  Ctrl+C will work 
    for Windows/Linux for copy in Sigil.  And via Qt's automatic remapping
    of Ctrl to CMD on macOS means that CMD+C will work for copy 
    just as macOS users would expect.
    

    inaccuracies and typos - part 3

    Finished the translation of the User's Guide.
    This is the last batch of inaccuracies and typos.
    I immediately upload a text file with errors. Please check it out.

    err-3.txt

    inaccuracies and typos - part 2

    This is a work in progress, and the second part of the typos in the text of the Guide has already appeared.
    I will immediately upload a text file with errors. Please check it.
    err-2.txt

    REGULAR EXPRESSION REFERENCE has incorrect regex command examples.

    Sigil_User_Guide_2019.09.03.epub (and previous versions) has two incorrect regex commands in the "REGULAR EXPRESSION REFERENCE" section/"OVERVIEW"/"SINGLE CHARACTERS:".

    [:alpha:] - should be in a bracket expression - [[:alpha:]]

    [^:alnum:] - should also be in a bracket expression - [^[:alnum:]]

    (I was puzzled by the second one and tried [[^:alnum:]] in Sigil. It matches not one, but two characters: the two :] instances above and a] in the metadata tutorial, line 33.)

    (First-time GitHub user)

    How to use Sigil?

    Hello, I'm sorry but I'm lost. It looks like an HTML editor, it is not clear to me how to import my .odt or .docx file and plit it into chapters. Is it a manual operation?

    Recommend Projects

    • React photo React

      A declarative, efficient, and flexible JavaScript library for building user interfaces.

    • Vue.js photo Vue.js

      🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

    • Typescript photo Typescript

      TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

    • TensorFlow photo TensorFlow

      An Open Source Machine Learning Framework for Everyone

    • Django photo Django

      The Web framework for perfectionists with deadlines.

    • D3 photo D3

      Bring data to life with SVG, Canvas and HTML. 📊📈🎉

    Recommend Topics

    • javascript

      JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

    • web

      Some thing interesting about web. New door for the world.

    • server

      A server is a program made to process requests and deliver data to clients.

    • Machine learning

      Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

    • Game

      Some thing interesting about game, make everyone happy.

    Recommend Org

    • Facebook photo Facebook

      We are working to build community through open source technology. NB: members must have two-factor auth.

    • Microsoft photo Microsoft

      Open source projects and samples from Microsoft.

    • Google photo Google

      Google ❤️ Open Source for everyone.

    • D3 photo D3

      Data-Driven Documents codes.