Skip to content

Commit

Permalink
Add rudimentary documentation for new external xhtml editor button
Browse files Browse the repository at this point in the history
  • Loading branch information
dougmassay committed Aug 28, 2019
1 parent d101fa2 commit 722d749
Show file tree
Hide file tree
Showing 6 changed files with 33 additions and 7 deletions.
4 changes: 4 additions & 0 deletions src/OEBPS/Text/TOC.xhtml
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,10 @@
<div class="sgc-toc-level-2">
<a href="../Text/external_editors.html">External Editors</a>
</div>

<div class="sgc-toc-level-2">
<a href="../Text/external_xhtml_editor.html">Special External Xhtml Editor</a>
</div>
</div>

<div class="sgc-toc-level-1">
Expand Down
20 changes: 20 additions & 0 deletions src/OEBPS/Text/external_xhtml_editor.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title></title>
<link href="../Styles/styles.css" type="text/css" rel="stylesheet"/>
</head>

<body>
<h2 id="opening_xhtml_externally">Special External Xhtml Editor</h2>

<p class="h2subheading">— Using Something like PageEdit Edit Xhtml Files —</p>

<p>Users can use something like the PageEdit program to edit an epub's xhtml files.</p>

<p>By setting the path to the external editor's executable in Sigil's preferences (<span class="menuitem">Edit-&gt;Preferences-&gt;General Settings-&gt;Set your preferred alternative external xhtml editor</span>), they can then launch the Book-View-selected file using the <span class="menuitem">Launch External Xhtml Editor</span> button on the Sigil toolbar (the icon looks like a paper and pencil). They can also use/assign the keyboard shortcut for the button to launch the editor (defaults to F2).</p>
</body>
</html>
2 changes: 1 addition & 1 deletion src/OEBPS/Text/find_replace.html
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ <h4 class="sigil_not_in_toc">Marked Text</h4>

<p>Text can be unmarked by using the menu item again without a selection.</p>

<p>Text will be unmarked if you use Undo, type any text, or change views or tabs. If you just use Replace or Replace All, the marked text will be expanded or shrunk appropriately.</p>
<p>Text will be unmarked if you use Undo, type any text, or change tabs. If you just use Replace or Replace All, the marked text will be expanded or shrunk appropriately.</p>

<h3 class="sigil_not_in_toc">Mode – Search Direction</h3>

Expand Down
2 changes: 1 addition & 1 deletion src/OEBPS/Text/preferences.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ <h3 class="sigil_not_in_toc" id="preferences_appearance">Appearance</h3>
</div>

<ul>
<li><span class="listheading">Main Menu Icon Size:</span> This slider changes the size of the icons in the main menu. <img src="../Images/preferences-appearance-slider.png" alt="image of slider to control icon size"/> </li>
<li><span class="listheading">Main Menu Icon Size:</span> This slider changes the size of the icons in the main menu. <img src="../Images/preferences-appearance-slider.png" alt="image of slider to control icon size"/></li>
</ul>

<h3 class="sigil_not_in_toc">General Settings</h3>
Expand Down
2 changes: 1 addition & 1 deletion src/OEBPS/Text/preview.html
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ <h3 class="sigil_not_in_toc">Inspector</h3>

<p>The Inspector Widget is opened/closed by clicking the flashlight button on the toolbar <img src="../Images/preview-window-toolbar.png" alt="preview window toolbar" width="40%"/> at the bottom of Preview. You can resize and reposition it how you like, and Sigil will remember your settings</p>

<p><img src="../Images/preview-window-inspector.png" alt="preview window inspector"/></p>
<p><img src="../Images/preview-window-inspector.png" alt="preview window inspector"/></p>

<p>The Inspector window is an HTML developer’s tool that allows detailed examination of the code behind the book’s appearance. It is intended to allow you to see why specific sections of your book are displayed the way they are, and to make temporary changes to styles and text to see how they affect your text.</p>

Expand Down
10 changes: 6 additions & 4 deletions src/OEBPS/content.opf
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
<?xml version="1.0" encoding="utf-8"?>
<package version="2.0" unique-identifier="unknown" xmlns="http://www.idpf.org/2007/opf">
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
<metadata xmlns:opf="http://www.idpf.org/2007/opf" xmlns:dc="http://purl.org/dc/elements/1.1/">
<dc:title>Sigil User Guide</dc:title>
<dc:creator opf:file-as="Heiland, Dave" opf:role="aut">Dave Heiland</dc:creator>
<dc:language>en</dc:language>
<dc:rights>Copyright © 2012, 2013 Dave Heiland</dc:rights>
<dc:date opf:event="published">2013-04-14</dc:date>
<dc:subject>Sigil, EPUB, ebook, editor</dc:subject>
<dc:date opf:event="modification">2019-06-25</dc:date>
<meta content="0.9.15" name="Sigil version" />
<dc:identifier opf:scheme="unknown" id="unknown">unknown</dc:identifier>
<dc:date opf:event="modification">2019-08-28</dc:date>
<meta name="Sigil version" content="0.9.17" />
<dc:identifier id="unknown" opf:scheme="unknown">unknown</dc:identifier>
<meta name="cover" content="cover.png" />
</metadata>
<manifest>
Expand Down Expand Up @@ -246,6 +246,7 @@
<item id="split-after2.png" href="Images/split-after2.png" media-type="image/png"/>
<item id="split-marker.png" href="Images/split-marker.png" media-type="image/png"/>
<item id="split-start.png" href="Images/split-start.png" media-type="image/png"/>
<item id="external_xhtml_editor.html" href="Text/external_xhtml_editor.html" media-type="application/xhtml+xml"/>
</manifest>
<spine toc="ncx">
<itemref idref="cover.html"/>
Expand Down Expand Up @@ -283,6 +284,7 @@
<itemref idref="indexes.html"/>
<itemref idref="reports.html"/>
<itemref idref="external_editors.html"/>
<itemref idref="external_xhtml_editor.html"/>
<itemref idref="manage_plugins.html"/>
<itemref idref="tutorials.html"/>
<itemref idref="tutorial_getting_started_with_epub.html"/>
Expand Down

0 comments on commit 722d749

Please sign in to comment.