Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Different Xcode 4 Documentation style + jump bar #169

Closed
dented42 opened this issue Jan 7, 2012 · 2 comments
Closed

Different Xcode 4 Documentation style + jump bar #169

dented42 opened this issue Jan 7, 2012 · 2 comments
Labels

Comments

@dented42
Copy link

dented42 commented Jan 7, 2012

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
Copy link
Owner

tomaz commented Jan 9, 2012

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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants