• Open Menu Close Menu
  • Apple
  • Shopping Bag
  • Apple
  • Mac
  • iPad
  • iPhone
  • Watch
  • TV
  • Music
  • Support
  • Search apple.com
  • Shopping Bag

Lists

Open Menu Close Menu
  • Terms and Conditions
  • Lists hosted on this site
  • Email the Postmaster
  • Tips for posting to public mailing lists
Re: Missing Documentation index.html files..
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Missing Documentation index.html files..


  • Subject: Re: Missing Documentation index.html files..
  • From: Andy Lee <email@hidden>
  • Date: Sun, 20 Dec 2009 19:16:18 -0500

If I may pimp my blog:

This post tells how to download the docs if Xcode isn't set to automatically download them, or if it hasn't done so yet:

<http://www.notesfromandy.com/2009/09/03/how-to-update-your-developer-docs/>

To Ron's point about going to the web site when the local file is not there, I wrote a quick-and-dirty bookmarklet that can help you switch from local browsing to online browsing.  It works in many cases for going to the online version of a local doc page:

<http://www.notesfromandy.com/2009/02/18/toad-curl/>

As an example of someone else using a web browser to navigate the docs, here's someone who does it very nicely with OmniWeb:

<http://www.notesfromandy.com/2009/07/18/another-way-to-browse-the-docs/>

--Andy (yeah, I know the blog hasn't been updated in ages, and neither has AppKiDo)


On Dec 20, 2009, at 3:44 PM, Ronald Hayden wrote:

>> Is there some way to generate the missing index files, or something else I can do to allow this kind of browsing?
>
> If you file a bug, we'll take a look at it. However, browsing the docs locally in Safari is not something we optimize or test for. Xcode has a lot of special handling that we can't replicate in Safari, such as (what may be hitting you here) the ability to check the website when a file doesn't exist locally.  This allows us to ship smaller doc sets that don't require as much bandwidth or disk space; PDFs are a good example of that, as they all reside on the website.
>
> As it happens, we do ship almost all files (except PDF), but this functionality gives us flexibility that allows us, for example, to ship an "index-only" or a "reference only" doc set with the GM release that requires almost no extra space but still gives complete access to the documentation until Xcode gets a chance to download the updated, mostly-complete doc set.  Without that, everyone would download the SDK with all the docs, then Xcode would immediately download the day-one update with several weeks of updated content, significantly increasing the download time for all.
>
> -- Ron
>
>
> On Dec 20, 2009, at 10:55 AM, joseph davison wrote:
>
>> I'm learning XCode and am really impressed with the documentation browser.
>>
>> However, sometimes I try to browse the developer documentation using Safari, which used to work successfully.  Now, however, there appear to be a number of missing index.html files that break that approach.
>>
>> For instance, if I open  the CoreReference docset at .../Contents/Resources/Documents/reference/index.html
>> in Safari most things work as expected.  However, if I use the "Jump To:" selector for "Guides" I get a File Not Found error, because .../Documents/documents/index.html  is not there.
>>
>> In fact, .../Documents/referencelibrary/index.html is also not there, which is why I opened .../reference/index.html in the first place.
>>
>> Is there some way to generate the missing index files, or something else I can do to allow this kind of browsing?
>>
>> --
>> joe
>>
>> _______________________________________________
>> 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
>
> _______________________________________________
> 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

 _______________________________________________
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

References: 
 >Missing Documentation index.html files.. (From: joseph davison <email@hidden>)
 >Re: Missing Documentation index.html files.. (From: Ronald Hayden <email@hidden>)

  • Prev by Date: Re: Missing Documentation index.html files..
  • Next by Date: Re: Warnings for undeclared methods?
  • Previous by thread: Re: Missing Documentation index.html files..
  • Next by thread: xcode 3.x outstanding code-generation bugs?
  • Index(es):
    • Date
    • Thread