| |
| lilypond:texi2html_issues [2013/03/13 10:42] – Externe Bearbeitung 127.0.0.1 | lilypond:texi2html_issues [2013/09/09 23:42] (aktuell) – gelöscht reinhold |
|---|
| ====== Current issues in the texi2html-transition of the Lilypond docs ====== | |
| ===== Open ===== | |
| |
| ==== Page layout / design ==== | |
| * SUGGESTION: (All manuals) Add a Google search line at the top of the TOC sidebar | |
| * Google's site: option in the search can contain a full path, e.g. [[http://www.google.de/search?q=site%3Alilypond.org/doc/v2.11/Documentation/+Pitches]] | |
| * How can we get the current docs directory to feed to google (we don't want to hardcode the lilypond.org server, do we?)? We'll probably need JavaScript for that | |
| * WISH: add auto-completion (probably needs AJAX, if it's possible at all) | |
| * WISH: search results should only replace the main pane (the <div id="main">), but leave the TOC pane untouched. AJAX is definitely needed for that. | |
| * See also Valentin's mail from Sept 22, 2008 | |
| * SUGGESTION: (All manuals) At Top, add an up link (called "(dir)" so far with texinfo) to go to the documentation index | |
| * Suggestion by Robin Bannister: Add this link in the TOC just above the headline. | |
| * Minor BUG: [[http://kainhofer.com/~lilypond/Documentation/user/music-glossary/index.html|MG]]: TOC too long (expand only up to first order???) | |
| * Minor BUG: The [[http://kainhofer.com/~lilypond/Documentation/topdocs/NEWS.html|News]] and [[http://kainhofer.com/~lilypond/input/regression/collated-files.html|regtest]] ([[http://kainhofer.com/~lilypond/input/regression/musicxml/collated-files.html|musicxml]]) pages also show an (empty) sidebar | |
| * BUG: In the [[http://kainhofer.com/~lilypond/input/lsr/lilypond-snippets/Pitches.html#Pitches|SL]] all snippets point to the start of the page instead of their own section. | |
| * SUGGESTION: In bigpages, add language links at the top rather than the bottom | |
| |
| ==== Texi2html problems ==== | |
| * BUG: All pages get duplicate access keys (one in the navigation bar at the top and the other at the bottom). This is annoying in Firefox => try to get rid of the access keys in the bottom navbar and only use access keys in the top bar. | |
| * texi2html BUG: [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-learning/Background.fr.html#FOOT3|Footnotes]] starting with @q{..} have broken line-breaking. | |
| * texi2html PROBLEM: In the [[http://kainhofer.com/~lilypond/Documentation/user/lilypond/Writing-pitches.html#Note-names-in-other-languages|pitch names in other lanugages]] table in NR, texi2html converts all table cells as ''<pre class="smallexample">[space]text[space_or_linebreak]</pre>'', which displays lots of spurious spaces and linebreaks. Ideally, all columns except the first would also be centered, but I don't know if that can be done in texinfo at all. | |
| * texi2html PROBLEM: In the [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-program/Filename-extensions.html#Filename-extensions|File name extensions]] table in AU (it's a @multitable inside a @quotation environment), texi2html wraps all cell contents inside a ''<p>'', so the cells are about twice as high as needed and the table is stretched way too much vertically. | |
| * texi2html PROBLEM: In the [[http://kainhofer.com/~lilypond/Documentation/user/music-glossary/Duration-names-notes-and-rests.html#Duration-names-notes-and-rests|MG Duration names table]] texi2html wraps all cells inside <p>, so they take up way too much space. | |
| |
| ==== Build system ==== | |
| * Buildsystem BUG: The snippets map is built only after the user docs are generated => map cannot be loaded there | |
| |
| ==== CSS issues ==== | |
| * CSS BUG: In nested blockquotes (e.g. the [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-internals/InnerChoirStaff.html#InnerChoirStaff|context properties in the IR]]) the inner quote should not have a frame and not use a fixed width. | |
| * Using `overflow: auto' for div#main breaks the browser's `Back' functionality when in-page anchors are clicked. | |
| * The current layout proportions only work for certain resolutions. Ideally, the CSS should adapt for high-resolution and low-resolution displays to maintain a more consistent look. | |
| |
| ===== Fixed ===== | |
| |
| * <del>Snippets page: On the start page, the "Pitches" link is on the same line as "Musical notation"! </del> | |
| * <del>LM: Preface uses index_1.html as file name!</del> | |
| * <del>Sidebar broken with Internet Explorer (scrolling disabled for whole page, sidebar scrolls with page)</del> | |
| * <del>Some external links (to other manuals) are still broken</del> | |
| * <del>The init file does not yet load the *_xref.map files.</del> | |
| * <del>the temporary map files are often removed by the make system</del> | |
| * <del>[[http://kainhofer.com/~lilypond/Documentation/user/lilypond-learning/Working-on-input-files.html#Working-on-input-files|LM 2.1.3]] uses German in the green box at the bottom</del> | |
| * <del>[[http://kainhofer.com/~lilypond/Documentation/user/lilypond-learning/About-the-documentation.html#About-the-Snippet-List-_0028SL_0029|LM 1.2]] writes "Top" for links to other manuals</del> | |
| * <del>[[http://kainhofer.com/~lilypond/Documentation/user/lilypond-internals/accidental_002dinterface.html|IR 3.2]]: Unnumbered subsections (interface properties) are all placed into volta_002dbracket_002dinterface.html, Solution: Don't use the file from the .xref-map for unnumbered sections, but blindly put them into the previous file. The anchor name should be used, though.</del> | |
| * <del>[[http://kainhofer.com/~lilypond/Documentation/topdocs/INSTALL.html|topdocs/INSTALL.html]]: texi2html does not find the included macros.itexi and install.itely...</del> | |
| * <del>On [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-big-page.html|big-pages]], the link to the bibliography is dangling, because ../../bibliography/index.html is not changed to ../bibliography/index.html</del> | |
| * <del>[[http://kainhofer.com/~lilypond/Documentation/user/lilypond-learning-big-page.html|Big page]]: section anchors from the .xref-map file are not assigned at all (element_file_name is not called if file is not split), instead SECxx is used (which is unsuitable for bookmarks or posting links to mailinglist, since these anchors will change when a section is inserted)!</del> | |
| * <del>[[http://kainhofer.com/~lilypond/input/lsr/lilypond-snippets/Pitches.html|Snippets page]]: The unnumberedsubsubsec (without any associated @node) are messed up in the internal navigation bars: The anchor is SECxx, which does not exist. Also, there is no text displayed.</del> | |
| * <del>Correctly implement alternative style sheets (i.e. use both style sheets als alternative style sheet)</del> | |
| * <del>SUGGESTION (Robin Bannister): Replace the (passive) text "Table of Contents" in the TOC panel with the document title, e.g. "Learning Manual". This is nearly always visible (on biggish screens). And when offscreen, near the end of NR, it is not far away.)</del> | |
| * <del>SUGGESTION (Robin Bannister): Make the TOC headline a link to the Top node of the manual, i.e. it is a link to the start of the document. Currently the TOC does NOT include any link to the Top node!</del> | |
| * <del>SUGGESTION (Robin Bannister): All manuals should have their document title headlined on the first page. The NR and the IR have a title that really doesn't tell you a lot! The AU and the LM do not use proper headline style (i.e. capitalized words). That's something that needs to be changed in the .tely file.</del> | |
| * <del>SUGGESTION: Combine the footer lines for bugs and docs suggestions into one line.</del> | |
| * <del>SUGGESTTION (Joseph Wakeling): Don't split the index into multiple pages</del> | |
| * <del>itely BUG: The [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-program/Command-line-options.html#Command-line-options|AU]] has two sections with title [[http://kainhofer.com/~lilypond/Documentation/user/lilypond-program/Command-line-options.html#Command-line-options|"Command line options"]] (one for lilypond, the other for convert-ly), which are placed into the same file. We should rename one of those sections!</del> | |
| |
