帮助书中的锚点无法正常工作

时间:2013-02-16 18:59:04

标签: cocoa xcode4 help-viewer apple-help

我已经仔细检查了一切,并希望有人能找到一个我没见过的愚蠢的错误。

我正在尝试为我的应用程序构建Apple帮助部分,它正确地转到登录页面,但没有任何锚点工作。着陆页称为index.html,另一页称为test.html,位于pgs目录中。

在index.html中我有:

<a href="help:anchor=support bookID=com.company.app_name.help">Link to another page</a>

在test.html中我有:

<a name="support"></a>

所以这是我为了到达现在所处的步骤而采取的步骤:

1)我构建了Apple documentation

指定的目录
AppName.help/
    Contents/
        Info.plist
        Resources/
            shrd/
            English.lproj/
                index.html
                search.helpindex
                pgs/
                    test.html

2)我按照Apple文档中的规定构建了Help Info.plist。我在Info.plist中将CFBundleIdentifier设置为com.company.app_name.help

3)在我的应用Info.plist中,我将CFBundleHelpBookFolder设置为AppName.help并将CFBundleHelpBookName设置为com.company.app_name.help

4)然后我将我内置的目录复制到Xcode中,同时确保为所有添加的文件夹选择了创建文件夹引用选项。

5)然后我使用帮助索引器索引目录AppName.help。确保我选择索引所有文件中的锚点信息 .I然后将.helpindex文件复制到 English.lproj 文件夹中。它应该是。

就是这样。如果我将以下链接放在 index.html 文件中,它可以正常工作,我注意到有关我的应用程序的一些事情。

<a href="pgs/test.html">Click this link</a>                 

此处还有 index.html 的代码:

<!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>AppName Help</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="robots" content="noindex" />
    <meta name="AppleTitle" content="AppName Help" />
    <meta name="AppleIcon" content="../shrd/icon.png" />
</head>
<body>
    <a href="help:anchor=support bookID=com.company.app_name.help">Link to another page</a>
</body>

以下是 test.html。

的代码
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<!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>Testing Links</title>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
        <meta name="robots" content="anchors" />
    </head>
    <body>
        <a name="support"></a>Does linking work?<br/>

    </body>
</html>

以下是我的帮助文件的Info.plist

<?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.company.app_name.help</string>
    <key>CFBundleInfoDictionaryVersion</key>
    <string>6.0</string>
    <key>CFBundleName</key>
    <string>AppName</string>
    <key>CFBundlePackageType</key>
    <string>BNDL</string>
    <key>CFBundleShortVersionString</key>
    <string>2</string>
    <key>CFBundleSignature</key>
    <string>hbwr</string>
    <key>CFBundleVersion</key>
    <string>2</string>
    <key>CFBundleHelpBookName</key>
    <string>AppName Help</string>
    <key>HPDBookAccessPath</key>
    <string>index.html</string>
    <key>HPDBookIconPath</key>
    <string>shrd/icon.png</string>
    <key>HPDBookIndexPath</key>
    <string>search.helpindex</string>
    <key>HPDBookKBProduct</key>
    <string>app_name1</string>
    <key>HPDBookKBURL</key>
    <string>http://www.company.com</string>
    <key>HPDBookRemoteURL</key>
    <string>http://www.company.com</string>
    <key>HPDBookTitle</key>
    <string>AppName Help</string>
    <key>HPDBookType</key>
    <string>3</string>
</dict>
</plist>

我也遵循了这篇文章:http://www.cocoabuilder.com/archive/cocoa/312037-updating-an-app-help.html除了重新索引目录外,每次更改时都清除缓存。

全部谢谢!

2 个答案:

答案 0 :(得分:5)

当然大卫, 谢谢你的提醒。

根据我的记忆和我的草率文档,我运行以下命令来索引帮助文档文件:

hiutil -vCaf ./search.helpindex English.lproj

然而,我意识到有一件事是索引实用程序会在任何时候使用&nbsp;字符时抱怨。而是替换角色&#32;

我认为这就是我的错误。

答案 1 :(得分:1)

如果一切正常,并且如果帮助不起作用仍然使用下面的代码。不确定安全问题,您可能需要研究从应用程序中删除文件。有时升级时的应用程序不会更新帮助文件并显示旧帮助文件的缓存副本,这些副本不包含新锚点。因此,下面的代码清除帮助缓存。另外还有一个更简洁的方法,你可以在Info.plist中增加帮助文件的构建版本,该文件位于帮助包内,而不是app info plist。这些字段是CFBundleShortVersionString CFBundleVersion

-(void)clearCacheHelp {
NSArray *arguments1 = [NSArray arrayWithObjects:@"helpd",nil];

NSTask * list1 = [[NSTask alloc] init];
[list1 setLaunchPath:@"/usr/bin/killall"];
[list1 setArguments:arguments1];


NSPipe * out1 = [NSPipe pipe];
[list1 setStandardOutput:out1];

[list1 launch];
[list1 waitUntilExit];


NSString *home = [self homeDirectory];

home = [home stringByAppendingPathComponent:@"Library/Caches/com.apple.helpd"];

NSArray *arguments  = [NSArray arrayWithObjects:@"-rf",home,nil];


NSTask * list = [[NSTask alloc] init];
[list setLaunchPath:@"/bin/rm"];
[list setArguments:arguments];


NSPipe * out = [NSPipe pipe];
[list setStandardOutput:out];

[list launch];
[list waitUntilExit];



NSString *home2 = [self homeDirectory];

home2 = [home2 stringByAppendingPathComponent:@"Library/Caches/com.apple.helpviewer"];

NSArray *arguments2  = [NSArray arrayWithObjects:@"-rf",home2,nil];


NSTask * list2 = [[NSTask alloc] init];
[list2 setLaunchPath:@"/bin/rm"];
[list2 setArguments:arguments2];


NSPipe * out2 = [NSPipe pipe];
[list2 setStandardOutput:out2];

[list2 launch];
[list2 waitUntilExit];


NSArray *arguments3  = [NSArray arrayWithObjects:@"-rf",@"~/Library/Caches/com.apple.helpd",nil];


NSTask * list3 = [[NSTask alloc] init];
[list3 setLaunchPath:@"/bin/rm"];
[list3 setArguments:arguments3];


NSPipe * out3 = [NSPipe pipe];
[list3 setStandardOutput:out3];

[list3 launch];
[list3 waitUntilExit];


NSArray *arguments4  = [NSArray arrayWithObjects:@"-rf",@"~/Library/Caches/com.apple.helpviewer",nil];


NSTask * list4 = [[NSTask alloc] init];
[list4 setLaunchPath:@"/bin/rm"];
[list4 setArguments:arguments4];


NSPipe * out4 = [NSPipe pipe];
[list4 setStandardOutput:out4];

[list4 launch];
[list4 waitUntilExit];


}