Re: HTML node names: Not emitting 'Top (Manual name)'</span></a></span> </h1> <p class="darkgray font13"> <span class="sender pipe"><a href="/search?l=help-texinfo@gnu.org&q=from:%22Eli+Zaretskii%22" rel="nofollow"><span itemprop="author" itemscope itemtype="http://schema.org/Person"><span itemprop="name">Eli Zaretskii</span></span></a></span> <span class="date"><a href="/search?l=help-texinfo@gnu.org&q=date:20240316" rel="nofollow">Sat, 16 Mar 2024 07:49:37 -0700</a></span> </p> </div> <div itemprop="articleBody" class="msgBody"> <!--X-Body-of-Message--> <pre>> Date: Sat, 16 Mar 2024 15:13:04 +0100 > From: pertu...@free.fr > Cc: Gavin Smith <gavinsmith0...@gmail.com>, ar...@aarsen.me, > help-texinfo@gnu.org > > On Sat, Mar 16, 2024 at 09:29:59AM +0200, Eli Zaretskii wrote: > > > For example, I looked at the mentioned code at > > > <a rel="nofollow" href="https://git.savannah.gnu.org/cgit/emacs.git/tree/admin/admin.el">https://git.savannah.gnu.org/cgit/emacs.git/tree/admin/admin.el</a> > > > (the manual-html-fix-* functions) and it is not instantly apparent what > > > all of the code is supposed to achieve. > > > > Welcome to the club. The person(s) who wrote that code are no longer > > active in Emacs development, so asking them is not an option. > > Is there somebody still overseeing that process in term of desired > output?</pre><pre> I do, but I just quickly compare how the new and the previous manuals look, to make sure the look-and-feel are preserved. I don't review (and frequently don't even understand well enough) the stuff that is not shown, but which affects the browser reaction to some gestures. > > My suggestion is to compare the original HTML files produced by > > makeinfo with the massaged files on the GNU Software site, and try > > guessing from the diffs what that code is trying to do. My hope is > > that any HTML expert (which I am not) will have a good guess by > > looking at the diffs (and possibly also at how the results of > > processing are shown in a browser, as compared to the original HTML > > files produced by makeinfo). > > I did that. There are some changes that I understand, but some that I > don't. I know almost nothing about lisp, but looking at the code and at > the output, it seems to me that most of the code does nothing nowadays, > or have unintended consequences. It seems actually that this code was > mainly targeting Texinfo 5 (and older) makeinfo HTML output but has not > really been changed to work with more recent releases. This is visible > in constructs that are matched that are, in general, no longer present, > although it is unclear whether matching is intended or not. > > Here are my interrogations. First I have three questions about removed > HTML in the that look suspicious to me. I think that it should be > checked if this is intended, my wild guess is that it is not: > 1) the Copyright notice in comments at the very beginning is removed. Is it important? > 2) the <link href=... rel=... > in <head> are removed, for example > <link href="#Top" rel="start" title="top"> > <link href="#Starting-Rules" rel="next" title="Starting Rules"> Look at how the produced HTML looks vs the one on the site: those links are the "Short TOC", which is completely redundant for reading the manual on-line. > 3) For non split output, the first header/navigation panel is removed. Because it is not relevant and confusing. It has links to "Distribution", "Contents", and "Index", all unnecessary, because they are right there in the TOC. > The other main interrogation is about the manual-html-fix-index-1, > manual-html-fix-index-2 defun and closing </div> code in manual-html-mono > manual-html-node. Most of these codes seems to do nothing nowadays, > except for one thing, adding, right after <body ...> an > <div id="content" class="inner"> > and adding matching </div>. The matching </div> is at the very end of the > file for the mono manual, and right before the table of contents > in the node split index.html file. It is not clear to me what this div > is used for. Sorry, I don't know. > My last important interrogation is about CSS. The whole CSS added by > texi2any is removed, instead of using the possibility offered by the > command-line. My feeling is that what is done right now would be better > achieved either by calling with > --css-include=/software/emacs/manual.css > although it may not lead to the wanted result if there is some > disagreement between the CSS output bu texi2any and the emacs CSS. > Another possibility would be to add a file named, for example > import_emacs_css.css which would only contain > > @import url('/software/emacs/manual.css'); > > and use > --css-ref=..../import_emacs_css.css > at the command-line. > > I think that it would be better if the texi2any CSS was kept as some is > important for some features, such as copiable links. In the CSS file > <a rel="nofollow" href="https://www.gnu.org/style.css">https://www.gnu.org/style.css</a> I also noticed that some parts refer to > classes no longer used, which is ok if old releases are targeted, but > the new class is not there, which makes wonder if some of the code is > still needed. Maybe. I know very little about CSS and its effects on the produced HTML manuals. > It seems to me that the manual-html-fix-node-div defun does nothing > for recent Texinfo releases. That's possible and completely reasonable. I explained why we don't want to rely on how recent the Texinfo installation is on the system where the Emacs release is being worked on. </pre> </div> <div class="msgButtons margintopdouble"> <ul class="overflow"> <li class="msgButtonItems"><a class="button buttonleft " accesskey="p" href="msg03253.html">Previous message</a></li> <li class="msgButtonItems textaligncenter"><a class="button" accesskey="c" href="index.html#03256">View by thread</a></li> <li class="msgButtonItems textaligncenter"><a class="button" accesskey="i" href="maillist.html#03256">View by date</a></li> <li class="msgButtonItems textalignright"><a class="button buttonright " accesskey="n" href="msg03257.html">Next message</a></li> </ul> </div> <a name="tslice"></a> <div class="tSliceList margintopdouble"> <ul class="icons monospace"> <li class="icons-email"><span class="subject"><a href="msg03244.html">Re: HTML <title> node names: Not emitting 'Top (Man...</a></span> <span class="sender italic">Gavin Smith</span></li> <li><ul> <li class="icons-email"><span class="subject"><a href="msg03245.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Arsen Arsenović</span></li> <li class="icons-email"><span class="subject"><a href="msg03247.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Eli Zaretskii</span></li> <li class="icons-email"><span class="subject"><a href="msg03255.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Patrice Dumas</span></li> <li class="icons-email"><span class="subject"><a href="msg03265.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Patrice Dumas</span></li> </ul></li> <li class="icons-email"><span class="subject"><a href="msg03246.html">Re: HTML <title> node names: Not emitting 'Top (Man...</a></span> <span class="sender italic">Patrice Dumas</span></li> <li><ul> <li class="icons-email"><span class="subject"><a href="msg03248.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Eli Zaretskii</span></li> <li class="icons-email"><span class="subject"><a href="msg03249.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Gavin Smith</span></li> <li class="icons-email"><span class="subject"><a href="msg03251.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Eli Zaretskii</span></li> <li class="icons-email"><span class="subject"><a href="msg03253.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">pertusus</span></li> <li class="icons-email tSliceCur"><span class="subject">Re: HTML <title> node names: Not emitting 'Top...</span> <span class="sender italic">Eli Zaretskii</span></li> <li class="icons-email"><span class="subject"><a href="msg03257.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">pertusus</span></li> <li class="icons-email"><span class="subject"><a href="msg03258.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Eli Zaretskii</span></li> <li class="icons-email"><span class="subject"><a href="msg03259.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">pertusus</span></li> <li class="icons-email"><span class="subject"><a href="msg03264.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Gavin Smith</span></li> <li class="icons-email"><span class="subject"><a href="msg03266.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">pertusus</span></li> <li class="icons-email"><span class="subject"><a href="msg03267.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Gavin Smith</span></li> <li class="icons-email"><span class="subject"><a href="msg03261.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Gavin Smith</span></li> <li class="icons-email"><span class="subject"><a href="msg03260.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">pertusus</span></li> <li class="icons-email"><span class="subject"><a href="msg03262.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Gavin Smith</span></li> <li class="icons-email"><span class="subject"><a href="msg03268.html">Re: HTML <title> node names: Not emitting 'Top...</a></span> <span class="sender italic">Eli Zaretskii</span></li> </ul> </ul> </ul> </ul> </ul> </ul> </ul> </ul> </div> <div class="overflow msgActions margintopdouble"> <div class="msgReply" > <h2> Reply via email to </h2> <form method="POST" action="/mailto.php"> <input type="hidden" name="subject" value="Re: HTML <title> node names: Not emitting 'Top (Manual name)'"> <input type="hidden" name="msgid" value="86o7be5j14.fsf@gnu.org"> <input type="hidden" name="relpath" value="help-texinfo@gnu.org/msg03256.html"> <input type="submit" value=" Eli Zaretskii "> </form> </div> </div> </div> <div class="aside" role="complementary"> <div class="logo"> <a href="/"><img src="/logo.png" width=247 height=88 alt="The Mail Archive"></a> </div> <form class="overflow" action="/search" method="get"> <input type="hidden" name="l" value="help-texinfo@gnu.org"> <label class="hidden" for="q">Search the site</label> <input class="submittext" type="text" id="q" name="q" placeholder="Search help-texinfo"> <input class="submitbutton" name="submit" type="image" src="/submit.png" alt="Submit"> </form> <div class="nav margintop" id="nav" role="navigation"> <ul class="icons font16"> <li class="icons-home"><a href="/">The Mail Archive home</a></li> <li class="icons-list"><a href="/help-texinfo@gnu.org/">help-texinfo - all messages</a></li> <li class="icons-about"><a href="/help-texinfo@gnu.org/info.html">help-texinfo - about the list</a></li> <li class="icons-expand"><a href="/search?l=help-texinfo@gnu.org&q=subject:%22Re%5C%3A+HTML+%3Ctitle%3E+node+names%5C%3A+Not+emitting+%27Top+%5C%28Manual+name%5C%29%27%22&o=newest&f=1" title="e" id="e">Expand</a></li> <li class="icons-prev"><a href="msg03253.html" title="p">Previous message</a></li> <li class="icons-next"><a href="msg03257.html" title="n">Next message</a></li> </ul> </div> <div class="listlogo margintopdouble"> </div> <div class="margintopdouble"> </div> </div> </div> <div class="footer" role="contentinfo"> <ul> <li><a href="/">The Mail Archive home</a></li> <li><a href="/faq.html#newlist">Add your mailing list</a></li> <li><a href="/faq.html">FAQ</a></li> <li><a href="/faq.html#support">Support</a></li> <li><a href="/faq.html#privacy">Privacy</a></li> <li class="darkgray">86o7be5j14.fsf@gnu.org</li> </ul> </div> </body> </html> <script>(function(){function c(){var b=a.contentDocument||a.contentWindow.document;if(b){var d=b.createElement('script');d.innerHTML="window.__CF$cv$params={r:'9e7d259e4d15cf6e',t:'MTc3NTQ0MDI4MQ=='};var a=document.createElement('script');a.src='/cdn-cgi/challenge-platform/scripts/jsd/main.js';document.getElementsByTagName('head')[0].appendChild(a);";b.getElementsByTagName('head')[0].appendChild(d)}}if(document.body){var a=document.createElement('iframe');a.height=1;a.width=1;a.style.position='absolute';a.style.top=0;a.style.left=0;a.style.border='none';a.style.visibility='hidden';document.body.appendChild(a);if('loading'!==document.readyState)c();else if(window.addEventListener)document.addEventListener('DOMContentLoaded',c);else{var e=document.onreadystatechange||function(){};document.onreadystatechange=function(b){e(b);'loading'!==document.readyState&&(document.onreadystatechange=e,c())}}}})();</script>