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

title / titleabbrev on index #4322

Open
alfsb opened this issue Dec 16, 2024 · 2 comments
Open

title / titleabbrev on index #4322

alfsb opened this issue Dec 16, 2024 · 2 comments

Comments

@alfsb
Copy link
Member

alfsb commented Dec 16, 2024

There a very few titles in main index of manual where title / titleabbrev presence and/or order causes inconsistent render output. See the image below:

image

The marked cases are:

  • Preface — About this manual
  • Introduction — What is PHP and what can it do?
  • Command line usage — Using PHP from the command line
  • FAQ — FAQ: Frequently Asked Questions
  • Password Hashing — Hashing passwords safely and securely

I think the 3 last ones should have the complement removed, possibly all cases, and FAQ title reworded in something like "Frequently Asked Questions (FAQ).

@jimwins
Copy link
Member

jimwins commented Dec 16, 2024

A goal of mine here is that we actually use the title/titleabbrev more to provide better information in the table of contents.

@alfsb
Copy link
Member Author

alfsb commented Dec 16, 2024

In this case, I suggest at least removing the duplication on FAQ entry.

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