| 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 |
| 12846 | eedwards | Adjust the FOP configuration to comment out fonts we normally use, but canno...t redistribute. « |
10 years ago |
| 12845 | eedwards | Tidy up the FOP configuration file, in preparation for setting up a Workshop-only version... that doesn't specify the fonts we use but are not licensed to redistribute. « |
10 years ago |
| 12844 | eedwards | Fix a Markdown link typo. | 10 years ago |
| 12843 | eedwards | #review-1055133 Add a sample guide to the doc infrastructure that demonstrates the direct...ory layout, configuration, and source markup for both AsciiDoc and DocBook. @matt, @jschaffer, and @jbujes should review. Rendered HTML is available for review: http://10.2.0.75/docs/ethel/index.html « |
10 years ago |
| 12842 | eedwards | Add Markdown docs for the doc infrastructure (which will be easy to read within the Works...hop). This should be sufficient to point users in the right direction, but there is certainly room for expansion. « |
10 years ago |
| 12841 | eedwards |
Update the sample oXygen catalog to be more Workshop-friendly. |
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 |
| 12836 | eedwards | Arrange for the doc build infrastructure to pass the output type through to AsciiDoctor p...rocessing, so that output-format specific image handling can work. « |
10 years ago |
| 12835 | eedwards | Upgrade BeautifulSoup from 4.1.0 to 4.3.2. This is a drop-in replacement, and there shoul...d be no difference in doc indexing results. However, docs can be indexed 2-4 times faster. « |
10 years ago |
| 12834 | eedwards | Fix minor configuration issue where, if the specified monospace font was not available, a... serif font was specified as the fallback. Now the fallback is monospace. « |
10 years ago |
| 12833 | eedwards | Update the ruby post-processor for AsciiDoc guides so that any existing dbhtml processing... instructions are identified, which causes a dbhtml PI to be injected immediately after the <book> tag. This allows AsciiDoc-based guides to specify which content should appear as index.html. The default index.html is generated when the dbhtml PI is not detected, and consists of the copyright statements. This includes the necessary update to the DVCS guide to make the Introduction chapter appear in index.html. « |
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 |
| 12830 | eedwards | #review-1031983 Incorporate AsciiDoc into the doc build infrastructure. This builds on Ma...tt's initial generate.rb, but uses its own version that is more generic and adds some rudimentary validation. Requirements to build AsciiDoc guides: - in the build.properties (or build.xml) for a guide, the property "input-xml" must point to the master AsciiDoc guide. - additionally, a property "input-type" must be set to "adoc". I.e.: "input-type=adoc". - Ruby must be installed and available in your path. - AsciiDoctor must be installed and available in your path. - The master AsciiDoc file must have a metadata line providing the guide's subtitle (which, by convention, is the release string, e.g. "2015.1"), like so: :subtitle: 2015.1 The standard invocations: - "ant pdf" to create a PDF, - "ant publicsite" to create HTML destined for perforce.com, - "ant htmlhelp" to provide the files for CHM production, - "ant product" (if implemented for the guide) to produce HTML destined for product inclusion should all work just as if the guide originated in DocBook XML. As the DVCS guide is the only one authored in AsciiDoc at this point, the necessary modifications to its configuration/source are included in this review, as well as a first cut of common AsciiDoc files for license statement inclusion. Note: I had to rename aa_license to aa_license.adoc because AsciiDoctor's include mechanism requires a known filename extension for nested includes. In the future, all AsciiDoc files should have the ".adoc" extension or frustration will prevail. « |
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 |
| 12826 | eedwards | Allow guide-specific assets to overwrite any generic assets. | 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 |
| 12824 | eedwards | Add a <keycap> customization to apply a Unicode font to the special <keycap>... symbols. « |
10 years ago |
| 12823 | eedwards | Add a new 'htmlhelp' doc build target that generates the HTML, index, TOC files that can... be compiled into a CHM file on a Windows machine using HTML Help Workshop. The build target can be used wherever the doc infrastructure runs, but the final CHM compilation currently needs to be performed on a Windows box. This means full CHM production automation is currently unavailable. Further investigation into non-Microsoft CHM compilers will be required for full automation. Note that any guide that requires CHM production will need to add its own 'htmlhelp' asset tree. The P4VS guide will (shortly) become a decent reference, if required. For any XSLT tinkerers, note that only a few of the 'htmlhelp' DocBook parameters are currently passed through to the transformation phase. If you need to pass any additional parameters through, add them to build.xml as appropriate. « |
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 |
| 12821 | eedwards | Adjust the page margins for PDF output so that the inner and outer margins match. This... provides a greater line length on each page that should help with the formatting of complicated tables, at the risk of providing a poorer experience for anyone who prints+binds our guides. However, we think very few users print the guides, and very few of those likely go to the trouble of binding. « |
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 |
| 12818 | eedwards |
Tweak the index presentation to use two columns, and the same font size at the body copy. |
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 |
| 12815 | eedwards | Apply a slightly larger width to ordered list labels so that it doesn't look like the num...bers run into the content, especially when the numbering goes from 9 to 10. « |
10 years ago |
| 12814 | tjuricek | Please do not submit .pyc files, which can change based on python version. Imported fro...m Git Author: Tristan Juricek <tjuricek@perforce.com> 1416506018 -0800 Committer: Tristan Juricek <tjuricek@perforce.com> 1416506018 -0800 sha1: 119ac4f5b47f2ff678466489677b6bb8065dc078 push-state: complete parent-changes: 6ce1d1757766a308d583b6d7a2b5b50574b9c1f1=[964381] « |
10 years ago |
| 12813 | eedwards | Apply a 1" bottom border globally for PDF generation, to work around a page break bug in... Apache FOP. This configuration had been applied selectively to specific guides, but it appears we hit this problem frequently enough to do it globally. « |
10 years ago |
| 12812 | eedwards | During transformation to PDF/HTML, the source XML is filtered/copied to the target-specif...ic output directory, and then transformation operates on the filtered XML. There was an assumption that input-xml was a relative path, but oXygen transformation scenarios provide absolute paths. This change fixes that assumption so that absolute paths get mapped to their relative locations within the output directory. « |
10 years ago |
| 12811 | eedwards | Add support for guide transformation targets to specify the use of assets from a differen...t target, and to then overlay their own assets on top. This makes it easy to have a single set of images, say from the publicsite target, that the product target can use, and then apply its own variations of those images (or additional images). Guides that wish to do this should update their target-specific build.properties file to specify assets-basedir-extra to be the base path for the overlay assets, and assets-dirs-extra to the asset inclusion criteria required. These two properties function identically to assets-basedir and assets-dirs, respectively. « |
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 |
| 12808 | eedwards | Update the comment for webhelp.include.search.tab to better reflect what it does and revi...se its default value to use an integer rather than a boolean. « |
10 years ago |
| 12807 | eedwards | Add support for a 'product' build target. The doc infrastructure already supports 'pdf'... and 'publicsite' targets; the latter is used to generate the HTML hosted on perforce.com. Newer products, such as P4Insights and Swarm 2.0, will need to also produce HTML that will be hosted by the product, and which should be styled (and possibly interact) like the product itself. This change includes a mechanism to cause the build to end without failure if a guide does not provide 'product' assets, specifically it looks for: <guide>/assets/product/build.properties If that file exists, the 'product' build continues as expected, otherwise it will report going through the motions without actually running any tasks. Currently, the 'product' HTML is identical to the 'publicsite' HTML. Guides that require product-specific HTML are required to customize both XSLT and CSS as necessary, but this gives them the standard presentation and functionality to start with. « |
10 years ago |
| 12806 | eedwards | Retire the mechanism for selecting the stylesheet for 'profiling', since it only worked b...y accident and it is unnecessary to do this differently for the various output formats. The path to profile.xsl is now specified in global.properties. This should have no effect on production of HTML or PDF for any guide. « |
10 years ago |
| 12805 | eedwards | Add a mechanism to remove a section from a TOC. In the CmdRef, the syntax, description,... usage notes, etc. appear in a standalone chapter. Each such chapter has very similar structure, and many appear on one page, so having the sub-sections appear in the TOC is not terribly useful for navigation purposes. Adding the attribute 'role="notoc"' prevents inclusion of the section's title in the enclosing TOC. This doesn't have any effect on the HTML presentation's navigation pane, just the PDF format's TOC. A future changelist will apply this feature to the CmdRef. « |
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 |
| 12803 | eedwards | Add doc generation infrastructure to the translations of the server guides. These current...ly include Intro, P4Dist, P4Guide, and P4SAG (the 2014.1 versions). This change includes: - adding a lang attribute to each guide to specify either "ko_kr" or "zh_cn" as appropriate, to inform DocBook transformations which generated elements (including TOC, chapter headings, cross-reference link text) to use. - Included the English screenshots for Intro and P4Guide, since these were not translated. - Tweaked the way common XML files are included to not depend on relative path structure (since the translations are nested within the English guide directory). - The common XML files have not yet been translated, so PDF or HTML transformations still include English content. Also, the HTML presentation includes English for various items, such as the search pane; these too have not yet been translated. « |
10 years ago |
| 12802 | eedwards | Set ulink.show=0 globally. This prevents links from displaying the associated URL when th...e link label does not match the URL. Individual guides that prefer the URL presentation can set ulink.show=1 in their own build.properties file. « |
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 |
| 12799 | eedwards | #review-919318 Updates to the CmdRef to replace links to our www.perforce.com hosted docu...mentation to be tied to a specific release. The thinking is that this should make the links more durable within products that include HTML docs. A future changelist will apply these changes to the rest of the server docs. « |
10 years ago |