| Change | User | Description | Committed |
|---|---|---|---|
| 12854 | eedwards | Fix JSON table of contents generation: markup in <refentry> tags introduces whitesp...ace that makes the JSON invalid. Now, the TOC entry's title has leading and trailing whitespace trimmed. « |
10 years ago |
| 12847 | eedwards | Disable Perforce documentation analytics for user builds. | 10 years ago |
| 12840 | eedwards |
Upgrade to jQuery 1.11.3 from 1.10.2. There should be no visible or operational changes. |
10 years ago |
| 12839 | eedwards | Upgrade Bootstrap to 3.3.4 (latest release) from 3.0.0. There should be no visible change...s. « |
10 years ago |
| 12838 | eedwards |
Fix a bug that broke index generation when UTF-8 entities exist in the index content. |
10 years ago |
| 12837 | eedwards | #review-1029519 Change the way that the TOC is generated for the HTML presentation: - no... longer include the TOC in each generated HTML page. - generate a JSON file representing the TOC. - add javascript to read the TOC in JSON format, and generate the appropriate HTML. - Remove the noscript block that prevents using the documentation with javascript disabled; just hide the search button because you can't use search without javascript. « |
10 years ago |
| 12832 | eedwards | Revise the javascript used in the HTML presentation to make the embedded English strings... easy to translate. Each translated guide would: - update the guide-specific XSLT to include something like: <xsl:template name="user.webhelp.foot.content"> <script type="text/javascript" src="js/guide.js"></script> </xsl:template> - edit the "guide.js" to reflect the actual name for the guide-specific javascript file to be included. - include in "guide.js": p4.locale_text = { "Reading time: about": "Reading time: about", "minute": "minute", "minutes": "minutes", "words": "words", "Documentation Keyboard Shortcuts": "Documentation Keyboard Shortcuts", "Show this help": "Show this help", "ESC": "ESC", "to close": "to close", "or": "or", "Next page": "Next page", "Previous page": "Previous page", "Scroll to top of current page": "Scroll to top of current page", "Go to the home page of this guide": "Go to the home page of this guide", "Go up one level in this guide": "Go up one level in this guide", "Open the search sidebar": "Open the search sidebar", "Clear the search term(s)": "Clear the search term(s)", "Click to expand": "Click to expand", "Click to shrink": "Click to shrink", "Exact Matches": "Exact Matches", "Fuzzy Matches": "Fuzzy Matches", "Phrase Matches": "Phrase Matches", } - Translate the right-hand side of the above messages. « |
10 years ago |
| 12831 | eedwards |
Fix a minor vertical alignment problem in the keyboard shortcuts dialog. |
10 years ago |
| 12829 | eedwards | Follow-on to @1030339: make the reading progress indicator span the entire width of the h...eader. « |
10 years ago |
| 12828 | eedwards | #review-1028126 Update the logo for both PDF, HTML, and CHM output. Includes updated favi...con.ico for the HTML output. Includes some additional tweaks: - In the HTML presentation, the "book" icon (to access the PDF, if available) and the magnifying glass icon for searching both look more clickable, using colors from the latest perforce.com design. - Also, both icons stick to the right edge of the doc content, rather than the right edge of the browser. - The background color in the HTML presentation is now plain white; the gradient image is removed. - The Google Analytics code is now included in the HTML presentation by default. Individual guides can disable this by setting the DocBook parameter perforce.analytics=0. Once this change is in place, subsequent generation of guides will incorporate these changes. « |
10 years ago |
| 12827 | eedwards | Add an estimate of reading time to the top of each HTML page. Also add an indicator of re...ading progress to the fixed header. « |
10 years ago |
| 12825 | eedwards | Disable the addition of a <br> tag after formal tables/examples/figures etc. for HT...ML output; it messes with the spacing we control via CSS. « |
10 years ago |
| 12822 | eedwards | Add additonal styles to provide the correct stacking order for popup elements. This shoul...d make them more reliably clickable. « |
10 years ago |
| 12820 | eedwards | CSS fix to improve popup image placement. | 10 years ago |
| 12819 | eedwards | Improve the appearance of numbered lists within admonitions by applying admonition-specif...ic colors to the left border and border/background of the number. « |
10 years ago |
| 12817 | eedwards | Improve the presentation of indexes in PDF/HTML. | 10 years ago |
| 12816 | eedwards | Adjust the selectors for eliminating paragraph margins to be more specific, to avoid remo...ving the margins for paragraphs following pre blocks. « |
10 years ago |
| 12810 | eedwards | Add styling tweaks for images with specified sizes. When this occurs, DocBook creates a... table to wrap around the image, and we want to turn off borders, cell padding, and the image's "max-width: 100%" styling to achieve the desired presentation. « |
10 years ago |
| 12809 | eedwards | #review-954548 Add the infrastructure to present a "PDF" link in the header bar in the HT...ML presentation. Not all guides provide PDF versions, so this is configurable on a guide-by-guide basis. The default is to omit the link. When a guide provides a PDF version, set the pdf.available attribute to the name of the PDF file that the link should target. For example, in P4Guide's publicsite build.properties: pdf.available=p4guide.pdf A subsequent changelist will apply this attribute to all of the server guides. « |
10 years ago |
| 12804 | eedwards | Add a new processing instruction <?chapterbreak?> which introduces one or two page... breaks so that following content appears on a recto page. A corresponding PI has been added to the HTML, which functions as a no-op, to avoid errors during transformation. This will help in the formatting of reference sections, where we prefer the content to appear in its own chapter, but still use recto pagination for each referenced item. « |
10 years ago |
| 12801 | eedwards | CSS fix for spacing of entries in a <variablelist>. | 10 years ago |
| 12800 | eedwards | Doc presentation tweaks: - For PDF cover page: - move logo to top-left from botto...m right - move title down - move subtitle near bottom - add <pubdate> presentation below subtitle (the <subtitle> now specifies the doc version) - tweaked font sizes - For HTML: - Add Perforce logo to header bar. - Add <subtitle> in brackets after guide title. « |
10 years ago |
| 12795 | eedwards | #review-932846 Tweak the styling for headings in the HTML presentation: - make second-l...evel and third-level headings slightly larger, to better visually distinguish them from lower-level headings - make second-level headings for preface, appendix, and reference "chapters" consistent with chapters. - better organization of the heading styles to group like styling together, and demonstrate the progression of styling. - remove the border between second-level sections in exchange for greater whitespace between them. - reference sections with partintro blocks included an extra horizontal rule, which is no longer displayed. - Includes a tweak to allow Firefox to scale images in a response manner. « |
11 years ago |
| 12793 | eedwards | Tweak the color of the bottom border of a table to match the bottom borders of cells with...in the table. « |
11 years ago |
| 12792 | eedwards | A few updates to presentation for HTML and PDF: - Chapter cross-references no longer ap...pear in italics. - For PDF, <gui*> tag content renders in bold, to match the HTML output. - HTML cross-references to chapters now appears in quotation marks, but cross-references to sections now have the quotation marks removed. - A number of spacing issues in the HTML output between list items, admonitions, images, and a following paragraph have been resolved. « |
11 years ago |
| 12787 | eedwards | #review-871968 Add additional hashtag processing to make it easier to craft URLs that tar...get specific portions of the HTML documentation when the provided section markers are not specific enough: #Sxx - scroll to xx percent down the page. e.g. #S45 to scroll 45% down the page. %Px - scroll to the xth "paragraph" block on the page, where code blocks are considered paragraphs, e.g. #P7 to scroll to the 7th "paragraph" %/xx - scroll to near the first instance of the text "xx". Matching is case-insensitive, and the text should be URI encoded. Wildcards not supported. e.g. #/Known%20limitations @gnicol should review. Rendered HTML is available for experimentation: http://ee.perforce.ca/docs/swarm.14.3/admin.security.html#S45 http://ee.perforce.ca/docs/swarm.14.3/admin.security.html#P11 http://ee.perforce.ca/docs/swarm.14.3/admin.security.html#/known%20limitations « |
11 years ago |
| 12786 | eedwards | Additional CSS to improve the experience of printing the HTML documentation. This does...n't address the 'single page' aspect of the job, but individual pages do appear much nicer on paper. « |
11 years ago |
| 12785 | eedwards |
Follow-on to 895408: better handling of negative scrolling situation. |
11 years ago |
| 12784 | eedwards | Improved nav pane scroll position when moving from page to page in a guide. The behaviour... isn't perfect in all situations yet, but is notably better. « |
11 years ago |
| 12783 | eedwards |
Add some margin below "framed" images to provide better separation for following content. |
11 years ago |
| 12782 | eedwards | Tweak CSS so that pop-up images, which only appear in the Swarm docs currently, are posit...ioned properly. Should have no other visible impact. « |
11 years ago |
| 12781 | eedwards | Correct the check for document_index so that if the index is not available, no javascript... errors occur that inhibit the rest of the UI. « |
11 years ago |
| 12780 | eedwards | Adjust the paragraph spacing within admonitions so that intermediary <literallayout>...; tags present as expected. « |
11 years ago |
| 12779 | eedwards |
Follow-on to @871273: Disable inclusion of HighlightJS, and re-enable Google Prettify. |
11 years ago |
| 12778 | eedwards | Remove the "aria-hidden" attribute from the documentation's "keyboard shortcuts" modal d...ialog, per @813797. For folks with screen readers, the close button should now be findable. « |
11 years ago |
| 12777 | eedwards | Follow-on to @871216: remove the invocation for HighlightJS, as this remains experimental... and would need license approval. « |
11 years ago |
| 12776 | eedwards | #review-851775 Updates to the HTML presentation: - remove the double DOCTYPE declarations.... - revise markup so that the content is no longer in an immovable container. This should allow the scroll position to be maintained by the browser and work as expected after users navigate within a page and then use the browser's back button. - rename the generated search index file to 'index.js' to avoid a mimetype issue. Also, made the search code tolerant of a missing index.js. - fix scrolling to targeted locations in a guide by applying an offset to the scroll to move the target out from under the header, and to animate the scroll. « |
11 years ago |
| 12775 | eedwards | Add HTML formatting for <simplelist> tags. (The PDF formatting is already adequate).... This should have no effect on existing docs, as <simplelist> does not appear to be used anywhere. Added to format a 'table' that appears in the forthcoming P4Convert docs (conversion to DocBook). « |
11 years ago |
| 12774 | eedwards |
#review-847001 Fix for incorrect offset to first matching highlighted search term. |
11 years ago |
| 12773 | eedwards | Add an additional override to Bootstrap so that code blocks (in <programlisting> ta...gs) do not word wrap when content that could be wrapped is near the right border of the text area in HTML. « |
11 years ago |
| 12772 | eedwards |
Minor CSS tweak to target pre-formatted only at the end of an admonition. |
11 years ago |
| 12771 | eedwards | Improve the presentation of pre-formatted text in admonitions for the HTML output: - r...emove the negative left/right margins so that the border around the text doesn't run into the admonition border. - if the pre-formatted text is the last element in an admonition, remove its bottom margin. - adjust the border and background color of the pre-formatted text to better match the color of the different types of admonitions. « |
11 years ago |
| 12770 | eedwards | Remove a stray 's' from the doc keyboard shortcuts modal dialog definition. This is norma...lly not visible, but would appear if the HTML page was printed. « |
11 years ago |
| 12769 | eedwards | HTML style tweaks: - for Internet Explorer 11, hide the browser's own 'clear' butt...on on input fields to prevent an ugly display problem where IE's clear button overlaps our own button. - make the border around <programlisting> tags just a touch lighter/less constrasty. - make <replaceable> content within <filename> tags inherit the <filename> color. - provide styling to help fix a vertical alignment issue when including "thumb" graphics in a paragraph. Documents that could use this fix need to change the <para> tag to <para condition="thumb">. « |
11 years ago |
| 12768 | eedwards | Update the handling of condition attributes in <para> tags so that it more correctl...y overrides the official DocBook version. There should be no functional change in current documents, but this should work better if/when para.propagates.style is set. « |
11 years ago |
| 12767 | eedwards | Add a processing instruction that allows for page breaks at specific locations in the PDF... docs. A similar PI is added for HTML docs, but it is a no-op (since the chunking facility takes care of that) to avoid errors. To use it, add <?pagebreak?> into the XML source where a page break is desired. This will have no effect on existing guides. « |
11 years ago |
| 12766 | eedwards | Updates to the HTML presentation for docs to better support users with Internet Explorer... 8: - removed used of HTML5 tags, such as header, footer and nav, which IE8 doesn't understand at all. - add Respond.js (MIT license), which simulates CSS media queries in IE8. - fix some issues with the javascript that IE8 could not handle. - add a custom IE8 stylesheet to include some very specific tweaks. The HTML for the following two guides has been updated, and is available for review for a limited time: http://ee.perforce.ca/docs/p4dist.ie8/ http://ee.perforce.ca/docs/swarm/ « |
11 years ago |
| 12765 | eedwards |
Adjust margin for the heading title so that a guide's title appears centered vertically. |
11 years ago |
| 12764 | eedwards | Make the style which presents the first paragraph in a procedure step bold apply more spe...cifically, so that subordinate list paragraphs do not also become bold. « |
11 years ago |
| 12762 | eedwards | Fix the color for linked <envar> and <uri> tags. | 11 years ago |