php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Request #73051 Improve misleading <literal> markup
Submitted: 2016-09-09 00:36 UTC Modified: 2016-09-22 17:43 UTC
From: cmb@php.net Assigned:
Status: Open Package: Website problem
PHP Version: Irrelevant OS: *
Private report: No CVE-ID: None
Have you experienced this issue?
Rate the importance of this bug to you:

 [2016-09-09 00:36 UTC] cmb@php.net
Description:
------------
I've just rejected a PhDOE submission for the German
file_put_contents() man page:

> - Der Wert von <parameter>flags</parameter> kann eine Kombination der folgenden Flags sein, verbunden mit dem binären OR(<literal>|</literal>)
> + Der Wert von <parameter>flags</parameter> kann eine Kombination der folgenden Flags sein, verbunden mit dem binären OR(|)

Obviously, the issue is that `|` looks like `/` in italics, what
is confusing. Therefore I suggest to style <literals> differently;
a non-proportional font might be better anyway, and perhaps a
(slightly) different background color would also be appropriate.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2016-09-22 16:30 UTC] kalle@php.net
What about a monospace font like Consolas or something?
 [2016-09-22 17:43 UTC] cmb@php.net
> What about a monospace font like Consolas or something?

That would be fine.
 
PHP Copyright © 2001-2020 The PHP Group
All rights reserved.
Last updated: Mon Feb 24 03:01:25 2020 UTC