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

content -H option -- shows subWiki page's help text as title in TOC and ... #718

Merged
merged 3 commits into from Apr 19, 2015

Conversation

Projects
None yet
3 participants
@andrey012
Contributor

andrey012 commented Apr 18, 2015

...shows subWiki page's name with small letters (i.e. swaps subWiki page's name and help text in TOC)

Main reason - to let make titles in TOC contain pieces of text, that are not allowed in page name (i.e. non-ASCII chars).

content -H option -- shows subWiki page's help text as title in TOC a…
…nd shows subWiki page's name with small letters (i.e. swaps subWiki page's name and help text in TOC)

Main reason - to let make titles in TOC contain pieces of text, that are not allowed in page name (i.e. non-ASCII chars).
@six42

This comment has been minimized.

Contributor

six42 commented Apr 18, 2015

Wow, this PR was fast.

@andrey012

This comment has been minimized.

Contributor

andrey012 commented Apr 18, 2015

This one was much easier then fetching headers from pages.
Actually -- thank you for -H idea.

AG

six42 wrote:

Wow, this PR was fast.


Reply to this email directly or view it on GitHub #718 (comment).

@amolenaar

This comment has been minimized.

Collaborator

amolenaar commented Apr 18, 2015

That's fast indeed.

I was checking the User guide full reference page with the new option and I love it:

screen shot 2015-04-18 at 22 37 17

I think the ': page name' can go, though, since it does not add useful information, or maybe put it in parenthesis,
Now I got confused with the normal help text:

screen shot 2015-04-18 at 22 37 36

@amolenaar amolenaar added this to the Next release milestone Apr 18, 2015

@andrey012

This comment has been minimized.

Contributor

andrey012 commented Apr 18, 2015

As for me - I'd leave the page name for those who maintain Wiki - it can be quite useful when moving and referencing pages, managing commits in Git-controlled wiki and similar things, especially if names will not be disgraced.
My initial idea was of giving better understanding for non-tech users, which, I think, is completely satisfied with this option. Page name, written with small letters, should not confuse them.
I can remove page name, or make them optional (in this case - please suggest a proper option to use).

AG

Arjan Molenaar wrote:

That's fast indeed.

I was checking the User guide full reference page with the new option and I love it:

screen shot 2015-04-18 at 22 37 17 https://cloud.githubusercontent.com/assets/96249/7217165/a8b4d4f4-e61b-11e4-8361-611b784a0567.png

I think the ': page name' can go, though, since it does not add useful information, or maybe put it in parenthesis,
Now I got confused with the normal help text:

screen shot 2015-04-18 at 22 37 36 https://cloud.githubusercontent.com/assets/96249/7217221/432c4616-e61c-11e4-85e4-8245efc16615.png


Reply to this email directly or view it on GitHub #718 (comment).

@amolenaar

This comment has been minimized.

Collaborator

amolenaar commented Apr 18, 2015

I think there's little need in showing the page name. Wiki maintainers can use the URL directly.

@andrey012

This comment has been minimized.

Contributor

andrey012 commented Apr 18, 2015

done.

AG
Arjan Molenaar wrote:

I think there's little need in showing the page name. Wiki maintainers can use the URL directly.


Reply to this email directly or view it on GitHub #718 (comment).

@amolenaar amolenaar merged commit b42c89c into unclebob:master Apr 19, 2015

amolenaar added a commit that referenced this pull request Apr 19, 2015

Merge pull request #718 from andrey012/content-H-option
content -H option -- shows subWiki page's help text as title in TOC and ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment