Re: Docsets and Research Assistant
Re: Docsets and Research Assistant
- Subject: Re: Docsets and Research Assistant
- From: Fritz Anderson <email@hidden>
- Date: Fri, 23 Nov 2007 16:32:00 -0500
This may or may not be further to my problem.
When I run docsetutil validate on my docset, I get:
ERROR: An excessive number of documents (5 of 6) were not found in the
full-text index.
The warnings were (class/category names redacted):
WARNING: Full-text index does not include node: Category02
WARNING: Full-text index does not include node: Class01.h
WARNING: Full-text index does not include node: Class01
WARNING: Full-text index does not include node: Class02
WARNING: Full-text index does not include node: Class02.h
Despite these warnings, the doc system's full-text search seems to
reach all the pages in my docset.
The documentation tree is HeaderDoc-generated, with a masterTOC.html
file and one folder per header at the root. Nodes.xml visits the index
pages for the headers and the classes/categories. It is appended to
this message.
Are these validation warnings normal? I'd guess not, as they add up to
an error.
How should I avoid them?
Do they relate to my inability to get Research Assistant to use my
documentation?
— F
On 21 Nov 2007, at 5:19 PM, Fritz Anderson wrote:
I'm writing a documentation set for my private framework, and am
working on Tokens.xml. My methods show up in the API search just fine.
1. Option-double-clicking works only when my docset is selected in
the Documentation window. Is that supposed to happen? Apple docsets
don't have this restriction.
2. The Research Assistant doesn't work at all for me. It works fine
for methods documented in Apple sets, but not for any method I
document.
...
<?xml version="1.0" encoding="UTF-8"?>
<DocSetNodes version="1.0">
<TOC>
<Node type="folder">
<Name>My Framework</Name>
<Path>masterTOC.html</Path>
<Subnodes>
<Node id="1">
<Name>Class01.h</Name>
<Path>Class01/index.html</Path>
<Subnodes>
<Node id="3">
<Name>Class01</Name>
<Path>Class01/Classes/Class01_</Path>
<File>index.html</File>
</Node> <!-- id 3 -->
</Subnodes>
</Node> <!-- id 1 -->
<Node id="2">
<Name>Class03.h</Name>
<Path>Class03/index.html</Path>
<Subnodes>
<Node id="4">
<Name>Category02</Name>
<Path>Class03/Categories/NSObject_Category02_</
Path>
<File>index.html</File>
</Node> <!-- id 4 -->
<Node id="5">
<Name>Class03</Name>
<Path>Class03/Classes/Class03_</Path>
<File>index.html</File>
</Node> <!-- id 5 -->
</Subnodes>
</Node> <!-- id 2 -->
</Subnodes>
</Node> <!-- root -->
</TOC>
</DocSetNodes>
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Xcode-users mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden