![]() I’ve been doing this for 5 years now and I’m extremely pleased on how well by docs LOOK, and how well they synchronize. You said you don’t like doc’ing - I get that, but really it’s so helpful for your work. The maxim: if you can’t explain it, you shouldn’t program it. And VERY IMPORTANTLY, one of the great things documentation does for the programmer is clears your mind and forces you to do things in your program THE CLIENTS WAY, not YOUR WAY. Once you get in the flow it’s very natrual and easy. I made this sound complicated, but it’s not. So there is some sharing, although it’s important for me to check the PDF so a graphic replacement that is a bigger size doesn’t look screwy or throw off the layout flow. With inDesign I can always keep in mind how I want larger or added areas to naturally flow, and when to page break appropriately so it’s natural to the reader.īTW, the HTML and the PDF do share graphic files, so any changes in those automatically update the PDF. I do the HTML first and make sure I copy-paste over to inDesign afterwards. That takes discipline, but isn’t that what programmers are supposed to have? So I always - no matter what - open up Dreamweaver and inDesign when I am editing the docs. And I want my PDF’s to look great, so I do this extra work, but it’s worth it.Īs far as maintenance goes, I have to ALWAYS make sure I synchronize the PDF to the HTML. Layout things on a page is so much different that laying it out on HTML, you want things to wrap differently around graphics and you want page breaks to be natural and not broken. That way I’m not going back and forth on the initial pass. Like I said, I have to transfer by hand everything from the HTML, but I make sure initially I do the PDF LAST, when I’m very confident in the HTML. I’ve used Pagemaker since the 1980’s so it’s real easy for me to use. So far so good, everything is platform-specific and industry-standard so no one should be surprised.įor the PDF I use Adobe’s inDesign, the best IMHO layout program around. ![]() Also, in my apps, I link to my company’s web site which has this same HTML code-base but it may be more updated than what their current HelpFile/HelpViewer is. For Mac I simply move it into the app bundle and HelpViewer displays it and it looks great. On Windows I use the standard old HTML Workshop from Microsoft to make the CHM Help File (standard). I am not convinced any of these automated solutions, even the expensive ones, have the intelligence (if it’s even possible) to make a decent-looking PDF document based on what has to be HTML for the other Help methods. Documentation should look good to impress your customers/clients. This is something all the automated solutions downplay. Purge option to reduce HND file size Automatic compression of uncompressed pictures New table tools to split, table, sort or convert to text Better style support Performance improvements.Although it is NOT single-code-based, I find it very effective and best of all makes everything look like I want it to. Generate eBooks in ePub and MobiPocket / Kindle format Re-introduced shortcuts to move, add or delete topics generate Word and PDF documentation in landscape mode Various enhancements in documentation output Translated to French Many fixes and enhancements New build system: create as many customized build of any documentation format as needed Added support for invisible topics Relative external library items are now imported at generation time It is now possible to indent bullets and numbering with the TAB key Many fixes and enhancements HTML documentation could not always select the first displayed table of contents item A frame was displayed around the content when printing a CHM topic Word generator always compressed bitmap pictures Word documentations could add extra empty lines before topic titles Fixes and enhancementsĬonditional build system: build multiple variations of a documentation Better CHM, HTML and PDF generation Easier documentation build list management Better Central-European and East-European language handling Better keyboard shortcuts Many fixes and enhancements ![]() Project analyzer will report various useful information about project: broken links, merge library items History of viewed topics with previous/next buttons New project dialog is now resizable The "Show Special Characters" feature is now persistent Various enhancements and bug fixes
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |