php / php/phd

Empty title change rendering of siblings

Open
#181 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
91
Forks
59
PR merge metrics
No merged PRs in 30d

Description

I'm about to merge an fixup that may start including empty <title>s in manual, in an effort to translations can be build able for more time, particully at times that doc-en is being heavy updated.

The fixup <title></title><simpara>%failed xi:xinclude%</simpara> (empty title) is saved on .manual.xml as:

<refsect1 role="parameters">
 <title/>
 <simpara>%failed xi:xinclude%</simpara>
</refsect1

and is rendered by php phd/render.php --format bigxhtml as:

<div class="refsect1 parameters" id="refsect1-function.bcdivmod-parameters">
  <h3 class="title"><p class="simpara">%failed xi:xinclude%</p></h3>
</div>

Instead of:

<div class="refsect1 parameters" id="refsect1-function.bcdivmod-parameters">
  <h3 class="title"></h3>
  <p class="simpara">%failed xi:xinclude%</p>
</div>

In other words, empty <title> causes their siblings to be rendered inside the title, instead of around it. I'm worried that this can swallows entire sections inside titles. In the meanwhile, and to workaround this, I'm placing some placeholder texts in fixup titles, but these ends rendered in manual.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Reproduce the issue with php phd/render.php --format bigxhtml using the shown .manual.xml structure containing an empty <title/> and a sibling . Trace the bigxhtml rendering path and verify that the completed output keeps the outside the empty

element.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.