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

Frames / No frames should be split into two templates #30

Closed
inossidabile opened this issue Mar 18, 2012 · 3 comments
Closed

Frames / No frames should be split into two templates #30

inossidabile opened this issue Mar 18, 2012 · 3 comments

Comments

@inossidabile
Copy link
Member

I'm quite unhappy with current implementation of frames/no-frames view. I agree it could be useful for someone to have non-frame view but I can't agree it's enabled by default and there's no way to change this behavior nor to exclude non-frame view completely.

I was going to split it into two separate templates if it's ok. Is it?

@inossidabile
Copy link
Member Author

Actually we could either consider dropping non-frame view completely :). And I'm +1 for that ;)

@netzpirat
Copy link
Contributor

I would not drop it, instead make the behavior configurable.

That's a good opportunity to clean up the Generator class, it's currently a mess: The index page is generated by Generator#generateReadme and in fact it's again created in Generator#generateExtras, just with a different output name.

I suggest to rename Generator#generateIndex to Generator#generateClassIndex, so we can introduce again Generator#generateIndex, but this time it really generates the index page :P

The index page then can then be configured:

  • Frames (default) or no frames
  • The index file (defaults to the README)
  • Enable (default) or disable frame/no frame switcher.

@inossidabile
Copy link
Member Author

I'm not sure if adding one more configuration level on top of ability to switch templates is a good idea. I'm up for refactoring but we should think twice if we really want this kind of configuration.

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

No branches or pull requests

2 participants