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

Language page categories #2369

Merged
merged 3 commits into from Oct 9, 2018
Merged

Language page categories #2369

merged 3 commits into from Oct 9, 2018

Conversation

finanalyst
Copy link
Collaborator

The problems

  1. The Language page (https://docs.perl6.org/language.html) contains a table of pages in an apparently random order because it depends on the name of the underlying pod6 file.
  • Tom Browder did most of the work to change this, but there was no distinction between the headings and the pages, and there was a link problem because links defined in the original pod files do not correspond to the re-ordered pod file
  1. A brief introduction to the Documentation is added to resolve Issue Create a HOWTO for newcomers to the repo #2266

Solution provided

  • Tom's work is modified to produce a language page that is based on his Control file.
  • The Headings of each section become level 2 headings on the language page, and the sub-pages are combined into tables.
  • The Makefile has been modified to include a new variable USE_CATEGORIES, which is set to False by default
  • Only when USE_CATEGORIES is set to True in the Makefile will the Categories be introduced. Thus merging these changes will not affect the current behaviour.
  • The mechanism for keeping the section headings and distinguishing between section pods and content pods is by creating a :class in the section pods.
  • The mechanism for keeping the old pod filenames is to introduce a :link<$key-fname> into the pod, and to ensure that the url attribute takes the old name.
  • The Language page now (if USE_CATEGORIES is set to True) looks much better and is more easily understandable. It also has a TOC.

Copy link
Contributor

@JJ JJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am very wary of accepting changes in htmlify.p6, since there's no test or specs on how it behave, the only way we have to know is to put it to use and check if it breaks anything. For the time being, it looks like it has not... So waiting for @tbrowder green light (who knows better this stuff), I'd say it's OK. Thanks a lot for your work.

@@ -450,6 +450,7 @@ sub help {
-n - create (for mode 'control')
-h - extended help
-d - debug
-m - manage (include the categories)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not aligned vertically with the rest of the lines

do-update()
} else {
copy-dir-tree :fromdir('doc'), :todir('build')
};
Copy link
Member

@AlexDaniel AlexDaniel Oct 9, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need for the semicolon here.


=TITLE Brief Introduction

=SUBTITLE Using the Perl6 Documentation
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole document says “Perl6” when I think we settled on “Perl 6” with no-breaking space. Maybe it is worth changing it, although with recent discussions regarding an alias it may be worth to reword some sentences so that the language name is not spelled out. @JJ what do you think?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That can be fixed when approved, no big deal.

@AlexDaniel
Copy link
Member

AlexDaniel commented Oct 9, 2018

@tbrowder pinged me on IRC. I looked at the code, seems to be OK. I left some nitpicking comments. This seems not to have blocking downsides that we previously had with @tbrowder++'s solution, so I recommend setting it to True by default.

@JJ JJ merged commit 1043e93 into Raku:master Oct 9, 2018
@JJ JJ mentioned this pull request Jan 18, 2019
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

Successfully merging this pull request may close these issues.

None yet

3 participants