Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Different Xcode 4 Documentation style + jump bar #169

Closed
dented42 opened this Issue · 2 comments

3 participants

@dented42

the built-in documentation sets appear differently depending on whether one is viewing them in Xcode or in a web browser, I think appledocs documentation should do the same.

In a web browser there is a large header at the top, as well as a table of contents on the left; whereas in Xcode the header is absent, and the table of contents is hidden in favor of the Xcode jump bar.

But with appledoc generated documentation it looks the same in both Xcode and safari, showing the web browser header and table of contents on the side, and does not take advantage of the jump bar.

@tomaz
Owner

This would require using different html template - either automatically when enabling doc set generation or via an explicit cmd line switch. Code change would be trivial, most of the work would go to updating html template.

@zwaldowski

A quick glance at Apple's documentation shows that they check for the Xcode user agent using JavaScript and toggling of CSS classes. They also do a bunch of things using frames, so that the data model links directly to just the documentation contents that are used as the contents of a frame in the web interface, so there's another possibility.

@tomaz tomaz closed this in 359a9ec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.