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

Tutorial indexes #35

Open
petebacondarwin opened this issue Feb 12, 2014 · 3 comments
Open

Tutorial indexes #35

petebacondarwin opened this issue Feb 12, 2014 · 3 comments

Comments

@petebacondarwin
Copy link
Contributor

It would be nice to use the @step tags to get the step number for the title of each tutorial page. At the moment this info is duplicated in the the @name tag:

@ngdoc tutorial
@name 2 - Angular Templates
@step 2
@description

We ought to be able to write only:

@ngdoc tutorial
@name Angular Templates
@step 2
@description

To do this we would need to add some logic to the tutorial template and also to ignore steps that were less than zero (otherwise the index file would get -1).

@forresst
Copy link
Contributor

Hi @petebacondarwin,

This feature should be included in the ngdoc package or must be available everywhere so in the base package?

@petebacondarwin
Copy link
Contributor Author

Ahah! Good question.
Actually the tutorial stuff is specific to the angular.js project so I guess it really should go there.
I envisage changing the computeIdsProcessor configuration for the "tutorial" and/or having a special processor that deals with the tutorial doctype. In this processor, we could compute the name and also set the sortOrder property so that tutorials were ordered in the same way as the general pages in the guide and so on.
What do you think?

@forresst
Copy link
Contributor

@petebacondarwin 👍

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

No branches or pull requests

2 participants