Skip to content

Commit

Permalink
New help book system.
Browse files Browse the repository at this point in the history
  • Loading branch information
btrask committed Jul 20, 2010
1 parent 98e7ac5 commit 3d9c979
Show file tree
Hide file tree
Showing 123 changed files with 564 additions and 492 deletions.
1 change: 1 addition & 0 deletions History.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
2.1.3 (Upcoming release)
- When opening a file with the Open dialog box, hold the Option key to simultaneously close the previous document.
- When attempting to open a document that is already open, make sure it becomes active.
- Fix problems that could prevent help pages from opening.

2.1.2 (January 22nd, 2010)
- The thumbnail sidebar now accepts keyboard focus.
Expand Down
4 changes: 2 additions & 2 deletions Info.plist
Original file line number Diff line number Diff line change
Expand Up @@ -644,9 +644,9 @@
<key>CFBundleGetInfoString</key>
<string>2.1.2</string>
<key>CFBundleHelpBookFolder</key>
<string>SequentialHelp</string>
<string>Sequential.help</string>
<key>CFBundleHelpBookName</key>
<string>Sequential Help</string>
<string>com.SequentialX.Sequential.help</string>
<key>CFBundleIconFile</key>
<string>Sequential</string>
<key>CFBundleIdentifier</key>
Expand Down
2 changes: 1 addition & 1 deletion PGDocumentController.m
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ - (IBAction)activateDocument:(id)sender

- (IBAction)showKeyboardShortcuts:(id)sender
{
[[NSHelpManager sharedHelpManager] openHelpAnchor:@"shortcuts" inBook:@"Sequential Help"];
[[NSHelpManager sharedHelpManager] openHelpAnchor:@"shortcuts" inBook:[[NSBundle mainBundle] objectForInfoDictionaryKey:PGCFBundleHelpBookNameKey]];
}

#pragma mark -
Expand Down
2 changes: 2 additions & 0 deletions PGFoundationAdditions.h
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */
// Other Sources
#import "PGGeometryTypes.h"

extern NSString *const PGCFBundleHelpBookNameKey;

NS_INLINE BOOL PGEqualObjects(id<NSObject> a, id<NSObject> b)
{
if(a == b) return YES;
Expand Down
2 changes: 2 additions & 0 deletions PGFoundationAdditions.m
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
// Other Sources
#import "PGDebug.h"

NSString *const PGCFBundleHelpBookNameKey = @"CFBundleHelpBookName";

NSString *PGOSTypeToStringQuoted(OSType type, BOOL flag)
{
return flag ? NSFileTypeForHFSTypeCode(type) : [(NSString *)UTCreateStringForOSType(type) autorelease];
Expand Down
2 changes: 1 addition & 1 deletion PGPreferenceWindowController.m
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ - (IBAction)changeDisplayScreen:(id)sender
}
- (IBAction)showPrefsHelp:(id)sender
{
[[NSHelpManager sharedHelpManager] openHelpAnchor:@"preferences" inBook:@"Sequential Help"];
[[NSHelpManager sharedHelpManager] openHelpAnchor:@"preferences" inBook:[[NSBundle mainBundle] objectForInfoDictionaryKey:PGCFBundleHelpBookNameKey]];
}
- (IBAction)changePane:(NSToolbarItem *)sender
{
Expand Down
30 changes: 30 additions & 0 deletions Sequential.help/Contents/Info.plist
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en-US</string>
<key>CFBundleIdentifier</key>
<string>com.SequentialX.Sequential.help</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>SequentialHelp</string>
<key>CFBundlePackageType</key>
<string>BNDL</string>
<key>CFBundleShortVersionString</key>
<string>1</string>
<key>CFBundleSignature</key>
<string>hbwr</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>HPDBookAccessPath</key>
<string>index.html</string>
<key>HPDBookIndexPath</key>
<string>SequentialHelp.helpindex</string>
<key>HPDBookTitle</key>
<string>Sequential Help</string>
<key>HPDBookType</key>
<string>3</string>
</dict>
</plist>
File renamed without changes
Binary file not shown.
25 changes: 25 additions & 0 deletions Sequential.help/Contents/Resources/de.lproj/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Sequential Help</title>
<meta name="AppleTitle" content="Sequential Help">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="main"></a>
<div>
<div style="float: right;"><a href="http://www.sequentialx.com/">sequentialx.com</a></div>
<h1><img src="../Sequential.png" class="icon"> Sequential</h1>
<table cellspacing=0 width=100%>
<tr class="header"><td>Topics</td></tr>
<tr><td><a href="help:anchor='shortcuts' bookID='com.SequentialX.Sequential.help'">Tastaturkurzbefehle</a></td></tr>
<tr><td><a href="help:anchor='preferences' bookID='com.SequentialX.Sequential.help'">Einstellungen</a></td></tr>
<tr><td><a href="help:anchor='scaling' bookID='com.SequentialX.Sequential.help'">Skalierungsmodi</a></td></tr>
<tr><td><a href="help:anchor='sessions' bookID='com.SequentialX.Sequential.help'">Sitzungen</a></td></tr>
<tr><td><a href="help:anchor='online' bookID='com.SequentialX.Sequential.help'">Bilder online ansehen</a></td></tr>
</table>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Viewing images online</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="online"></a>
<h1><img src="Sequential.png" class="icon"> Bilder online ansehen</h1>
<h1><img src="../Sequential.png" class="icon"> Bilder online ansehen</h1>
<p>Sie können jedes unterstützte Format direkt aus dem Internet öffnen. Wählen Sie Ablage > URL öffnen ... oder ziehen Sie die URL direkt aus einem anderen Programm auf das Docksymbol von Sequential.</p>
<p>Wenn die URL auf eine Webseite verweist, überprüft Sequential die Seite nach zu öffnenden Links und eingebetteten Bilder.</p>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Preferences</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="preferences"></a>
<h1><img src="Sequential.png" class="icon"> Einstellungen</h1>
<h1><img src="../Sequential.png" class="icon"> Einstellungen</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td width=30%>Allgemein</td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Scaling modes</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="scaling"></a>
<h1><img src="Sequential.png" class="icon"> Skalierungsmodi</h1>
<h1><img src="../Sequential.png" class="icon"> Skalierungsmodi</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td>Modus</td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Pausing and resuming sessions</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="sessions"></a>
<h1><img src="Sequential.png" class="icon"> Sitzungen</h1>
<h1><img src="../Sequential.png" class="icon"> Sitzungen</h1>
<p>Sie können die Anzeige von Bildern jederzeit stoppen und schnell zur gleichen Seite zurückkehren, wenn Sie Ablage > Pause wählen. Die Seite wird an der obersten Stelle des Fortsetzen-Menüs hinzugefügt und das Dokument geschlossen.</p>
<p>Wenn Sie weiter machen wollen, wählen Sie Ablage > Fortsetzen. Das Bild wird geöffnet und die Pause-Sitzung entfernt.</p>
<p>Sie könne eine Sitzung ohne zu öffnen löschen, wenn Sie Wahltaste halten und den Eintrag aus Ablage > Löschen auswählen.</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Keyboard Shortcuts</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="shortcuts"></a>
<h1><img src="Sequential.png" class="icon"> Tastaturkurzbefehle</h1>
<h1><img src="../Sequential.png" class="icon"> Tastaturkurzbefehle</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td>Dokumente & Sitzungen</td>
<td>Dokumente &amp; Sitzungen</td>
<td>Kurzbefehl</td>
</tr>
<tr>
Expand Down
Binary file not shown.
25 changes: 25 additions & 0 deletions Sequential.help/Contents/Resources/en.lproj/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Sequential Help</title>
<meta name="AppleTitle" content="Sequential Help">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="main"></a>
<div>
<div style="float: right;"><a href="http://www.sequentialx.com/">sequentialx.com</a></div>
<h1><img src="../Sequential.png" class="icon"> Sequential</h1>
<table cellspacing=0 width=100%>
<tr class="header"><td>Topics</td></tr>
<tr><td><a href="help:anchor='shortcuts' bookID='com.SequentialX.Sequential.help'">Keyboard shortcuts</a></td></tr>
<tr><td><a href="help:anchor='preferences' bookID='com.SequentialX.Sequential.help'">Preferences</a></td></tr>
<tr><td><a href="help:anchor='scaling' bookID='com.SequentialX.Sequential.help'">Scaling modes</a></td></tr>
<tr><td><a href="help:anchor='sessions' bookID='com.SequentialX.Sequential.help'">Sessions</a></td></tr>
<tr><td><a href="help:anchor='online' bookID='com.SequentialX.Sequential.help'">Viewing images online</a></td></tr>
</table>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Viewing images online</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="online"></a>
<h1><img src="Sequential.png" class="icon"> Viewing images online</h1>
<h1><img src="../Sequential.png" class="icon"> Viewing images online</h1>
<p>You can open any supported format directly from the internet. To do so, choose File > Open URL… or drag the URL from another application onto Sequential's Dock icon.</p>
<p>If the URL refers to a web page, Sequential will scan the page for openable links and embedded images.</p>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Preferences</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="preferences"></a>
<h1><img src="Sequential.png" class="icon"> Preferences</h1>
<h1><img src="../Sequential.png" class="icon"> Preferences</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td width=30%>General</td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Scaling modes</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="scaling"></a>
<h1><img src="Sequential.png" class="icon"> Scaling modes</h1>
<h1><img src="../Sequential.png" class="icon"> Scaling modes</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td>Mode</td>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Pausing and resuming sessions</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="sessions"></a>
<h1><img src="Sequential.png" class="icon"> Sessions</h1>
<h1><img src="../Sequential.png" class="icon"> Sessions</h1>
<p>You can stop viewing at any time and quickly return to the same page later by choosing File > Pause. The page is then added to the top of the Resume menu and the document is closed.</p>
<p>When you wish to resume viewing the page, select it from File > Resume. The image will be reopened and the pause session removed.</p>
<p>You can delete a session without opening it by holding Option and then choosing it from File > Delete.</p>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Keyboard Shortcuts</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="shortcuts"></a>
<h1><img src="Sequential.png" class="icon"> Keyboard Shortcuts</h1>
<h1><img src="../Sequential.png" class="icon"> Keyboard Shortcuts</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td>Documents & sessions</td>
<td>Documents &amp; sessions</td>
<td>Shortcut</td>
</tr>
<tr>
Expand Down
Binary file not shown.
25 changes: 25 additions & 0 deletions Sequential.help/Contents/Resources/es.lproj/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Ayuda Sequential</title>
<meta name="AppleTitle" content="Sequential Help">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="main"></a>
<div>
<div style="float: right;"><a href="http://www.sequentialx.com/">sequentialx.com</a></div>
<h1><img src="../Sequential.png" class="icon"> Sequential</h1>
<table cellspacing=0 width=100%>
<tr class="header"><td>Temas</td></tr>
<tr><td><a href="help:anchor='shortcuts' bookID='com.SequentialX.Sequential.help'">Comandos de teclado</a></td></tr>
<tr><td><a href="help:anchor='preferences' bookID='com.SequentialX.Sequential.help'">Preferencias</a></td></tr>
<tr><td><a href="help:anchor='scaling' bookID='com.SequentialX.Sequential.help'">Modos de escalado</a></td></tr>
<tr><td><a href="help:anchor='sessions' bookID='com.SequentialX.Sequential.help'">Sesiones</a></td></tr>
<tr><td><a href="help:anchor='online' bookID='com.SequentialX.Sequential.help'">Ver imágenes de internet</a></td></tr>
</table>
</div>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Ver imágenes en línea</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="online"></a>
<h1><img src="Sequential.png" class="icon"> Ver imágenes de internet</h1>
<h1><img src="../Sequential.png" class="icon"> Ver imágenes de internet</h1>
<p>Puede ver cualquier formato soportado directamente desde internet Para hacer esto, seleccione Archivo > Abrir URL… O arrastre la URL desde otra aplicación al icono de Sequential en el Dock.</p>
<p>si la URL se refiere a una página web, Sequential buscará enlaces que pueda abrir e imágenes incluídas.</p>
</body>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
<html>
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<title>Preferences</title>
<link rel="stylesheet" type="text/css" href="main.css" media="all">
<link rel="stylesheet" type="text/css" href="../main.css" media="all">
</head>
<body>
<a name="preferences"></a>
<h1><img src="Sequential.png" class="icon"> Preferences</h1>
<h1><img src="../Sequential.png" class="icon"> Preferences</h1>
<table cellspacing=0 width=100%>
<tr class="header">
<td width=30%>General</td>
Expand Down
Loading

0 comments on commit 3d9c979

Please sign in to comment.