| 1 | 2005-08-11 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 2 |
|
|---|
| 3 | * lists.xsl: Fixed check for first following siblings in lists.
|
|---|
| 4 |
|
|---|
| 5 | 2005-08-09 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 6 |
|
|---|
| 7 | * block.xsl, lists.xsl, utility.xsl: Output .sp macro in mixed blocks where we were outputting
|
|---|
| 8 | completely blank line before. Thanks (again) to Costin Stroie for
|
|---|
| 9 | pointing out the problems and providing a test case.
|
|---|
| 10 |
|
|---|
| 11 | Also, corrected the test for checking first preceding siblings of
|
|---|
| 12 | text nodes in mixed blocks (the test is used for determining
|
|---|
| 13 | whether or not we need to insert a line break before those nodes.)
|
|---|
| 14 |
|
|---|
| 15 | 2005-08-05 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 16 |
|
|---|
| 17 | * utility.xsl: Fixed bug that caused literal .sp to show up in output. (Thanks to
|
|---|
| 18 | Costin Stroie for reporting).
|
|---|
| 19 |
|
|---|
| 20 | WARNING: One of the consequences of this change is that the
|
|---|
| 21 | stylesheet no longer generates spaces at the end of certain lines.
|
|---|
| 22 | I had it doing that as a sort of hack to prevent certain kinds of
|
|---|
| 23 | problems in output. It seems like the hack my no longer be
|
|---|
| 24 | necessary. But if I am wrong, this change may cause spaces to show
|
|---|
| 25 | up at the beginning of some lines in "mixed content". If you see
|
|---|
| 26 | those, then this change has introduced a regression, and I will
|
|---|
| 27 | need to go back and figure out the right way to fix it (instead of
|
|---|
| 28 | the kludgy way I was doing it before.
|
|---|
| 29 |
|
|---|
| 30 | Also, instances like the following were showing up in some cases.
|
|---|
| 31 |
|
|---|
| 32 | .PP
|
|---|
| 33 | .sp
|
|---|
| 34 |
|
|---|
| 35 | That is, a .PP macro immediately followed by a .sp macro. I can
|
|---|
| 36 | think of no good read to ever generate that, and I am not sure why
|
|---|
| 37 | it is getting generated. So I have taked the lazy way out and
|
|---|
| 38 | caused the stylesheet to now strip out the .sp from all such
|
|---|
| 39 | instances, leaving just the .PP
|
|---|
| 40 |
|
|---|
| 41 | 2005-07-24 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 42 |
|
|---|
| 43 | * block.xsl, lists.xsl, utility.xsl: New file.
|
|---|
| 44 |
|
|---|
| 45 | * block.xsl, lists.xsl, utility.xsl: Fixed handling of lists with titles. Also reworked handling of
|
|---|
| 46 | space around lists. (Closes #1243003 and 1241371).
|
|---|
| 47 |
|
|---|
| 48 | Among other things, this change "normalizes" line space before and
|
|---|
| 49 | after verbatims. For most cases, the stylesheet now attempts to
|
|---|
| 50 | ensure each verbatim is preceded and followed by exactly one line
|
|---|
| 51 | of space.
|
|---|
| 52 |
|
|---|
| 53 | 2005-07-14 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 54 |
|
|---|
| 55 | * links.xsl: Removed unnecessary .br requests.
|
|---|
| 56 |
|
|---|
| 57 | * links.xsl: Use string value of link contents in link list so character
|
|---|
| 58 | formatting is "normalized" (no bold or ital).
|
|---|
| 59 |
|
|---|
| 60 | 2005-07-13 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 61 |
|
|---|
| 62 | * inline.xsl, param.ent, param.xweb: Prevent hyphenation of computer inlines, filenames, and URLs.
|
|---|
| 63 | (Closes #1124391; thanks to Ryan Hofschneider for reporting).
|
|---|
| 64 |
|
|---|
| 65 | By default, even when hyphenation is enabled (globally),
|
|---|
| 66 | hyphenation is now suppressed for "computer inlines" (currently,
|
|---|
| 67 | just classname, constant, envar, errorcode, option, replaceable,
|
|---|
| 68 | userinput, type, varname -- but probably need to add more) and for
|
|---|
| 69 | filenames, and for URLs from Ulink.
|
|---|
| 70 |
|
|---|
| 71 | It can be (re)enabled using the man.hyphenate.computer.inlines,
|
|---|
| 72 | man.hyphenate.filenames, and man.hyphenate.urls params.
|
|---|
| 73 |
|
|---|
| 74 | * lists.xsl: branches: 1.18.2;
|
|---|
| 75 | Removed unnecessary .LP requests that were being generated after
|
|---|
| 76 | lists. I don't know why those were there, but they have apparently
|
|---|
| 77 | been in since the code was first added to the repository.
|
|---|
| 78 |
|
|---|
| 79 | * synop.xsl: Made Funcsynopsisinfo bold, and made it a proper .PP block, and
|
|---|
| 80 | removed the extra space (.sp) that was being added after it.
|
|---|
| 81 |
|
|---|
| 82 | 2005-07-12 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 83 |
|
|---|
| 84 | * inline.xsl, links.xsl, synop.xsl: Added support for suppressing hyphenation of "computer inlines"
|
|---|
| 85 | and filenames and URLs. More details to follow with param
|
|---|
| 86 | checkins.
|
|---|
| 87 |
|
|---|
| 88 | * synop.xsl: Boldface everything in Funcsynopsis output except params.
|
|---|
| 89 | Closes #1236641.
|
|---|
| 90 |
|
|---|
| 91 | The man(7) man page says:
|
|---|
| 92 |
|
|---|
| 93 | For functions, the arguments are always specified using italics,
|
|---|
| 94 | even in the SYNOPSIS section, where the rest of the function is
|
|---|
| 95 | specified in bold:
|
|---|
| 96 |
|
|---|
| 97 | A look through the contents of the man/man2 directory shows that
|
|---|
| 98 | most (all) existing pages do follow this "everything in bold" rule.
|
|---|
| 99 |
|
|---|
| 100 | That means the <type> content and any punctuation (parens,
|
|---|
| 101 | semicolons, varargs) also must be bolded.
|
|---|
| 102 |
|
|---|
| 103 | * utility.xsl: branches: 1.2.2;
|
|---|
| 104 | Added support for suppressing hyphenation of "computer inlines"
|
|---|
| 105 | and filenames and URLs. More details to follow with param
|
|---|
| 106 | checkins.
|
|---|
| 107 |
|
|---|
| 108 | 2005-07-11 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 109 |
|
|---|
| 110 | * docbook.xsl, inline.xsl, links.xsl, param.ent, param.xweb:
|
|---|
| 111 | Implemented out-of-line handling of URLs for links (Ulinks).
|
|---|
| 112 | (Closes #1234711 and #1233909)
|
|---|
| 113 |
|
|---|
| 114 | For display of links, this implementation gives users three choices:
|
|---|
| 115 |
|
|---|
| 116 | 1. Number & list links. Each link is numbered and a numbered
|
|---|
| 117 | list of all links is added to the end of the document.
|
|---|
| 118 |
|
|---|
| 119 | or
|
|---|
| 120 |
|
|---|
| 121 | 2. Only list links. Links are not numbered, but an (unnumbered)
|
|---|
| 122 | list of links is added to the end of the document.
|
|---|
| 123 |
|
|---|
| 124 | or
|
|---|
| 125 |
|
|---|
| 126 | 3. Suppress links. Don't number links and don't add any list of
|
|---|
| 127 | links to the end of the document
|
|---|
| 128 |
|
|---|
| 129 | Users can also choose whether links should be underlined.
|
|---|
| 130 |
|
|---|
| 131 | Default is "the works" -- list, number, and underline links. The
|
|---|
| 132 | man.links.* parameters can be used to change the defaults.
|
|---|
| 133 |
|
|---|
| 134 | The default heading for the link list is REFERENCES. That can be
|
|---|
| 135 | changed using the man.links.list.heading param.
|
|---|
| 136 |
|
|---|
| 137 | There is a performance hit for listing and numbering links. But it
|
|---|
| 138 | is not an unreasonable one.
|
|---|
| 139 |
|
|---|
| 140 | The code currently only checks for Ulinks. It can be updated later
|
|---|
| 141 | (possibly) to deal with DocBook NG linking. But come to think of
|
|---|
| 142 | it, DocBook NG links get converted by the strip-ns template. So
|
|---|
| 143 | DocBook NG users will just need to run that first. Or, if I can
|
|---|
| 144 | ever manage to get the single-pass conversion process to work with
|
|---|
| 145 | manpages, it will get done automatically.
|
|---|
| 146 |
|
|---|
| 147 | * other.xsl: New file.
|
|---|
| 148 |
|
|---|
| 149 | 2005-07-10 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 150 |
|
|---|
| 151 | * inline.xsl: ulink handling now working as expected; but performance is poor
|
|---|
| 152 | for docs that have a lot of ulinks; that needs to be fixed
|
|---|
| 153 |
|
|---|
| 154 | * inline.xsl: Ulink handling -- fixed performance issue (per-Refentry sets of
|
|---|
| 155 | Ulinks are now assembled once per document and stored in a
|
|---|
| 156 | global variable).
|
|---|
| 157 |
|
|---|
| 158 | It now takes roughly on the order of 15 to 20 percent longer to
|
|---|
| 159 | process a doc with links numbered than it does to process it with
|
|---|
| 160 | links unnumbered. Which may sound like a lot, but with a doc that
|
|---|
| 161 | has 100+ links, on my machine, that still amounts to less than a
|
|---|
| 162 | one-second difference (only about 0.7 seconds).
|
|---|
| 163 |
|
|---|
| 164 | * inline.xsl: Checkpointing further ulink changes.
|
|---|
| 165 |
|
|---|
| 166 | 2005-07-09 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 167 |
|
|---|
| 168 | * docbook.xsl, info.xsl, inline.xsl: ulink fixes. (initial implementation of out-of-line handling of ulinks)
|
|---|
| 169 |
|
|---|
| 170 | * inline.xsl: Checkpointing further ulink changes. All visible links are now
|
|---|
| 171 | displayed in the link list, and numbered. But it performance
|
|---|
| 172 | leaves something to be desired. And not working properly for case
|
|---|
| 173 | where document contains multiple Refentry.
|
|---|
| 174 |
|
|---|
| 175 | * inline.xsl: Checkpointing. Now link list contains unique URLs (removes dupes),
|
|---|
| 176 | but needs more work -- some URLs are getting suppressed that
|
|---|
| 177 | shouldn't be; one symptom of that is that numbering is thrown off.
|
|---|
| 178 |
|
|---|
| 179 | * other.xsl: branches: 1.11.2;
|
|---|
| 180 | ulink fixes. (initial implementation of out-of-line handling of ulinks)
|
|---|
| 181 |
|
|---|
| 182 | 2005-07-08 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 183 |
|
|---|
| 184 | * lists.xsl: Removed redundant template.
|
|---|
| 185 |
|
|---|
| 186 | * param.ent, param.xweb: Added new params for controlling link handling.
|
|---|
| 187 |
|
|---|
| 188 | 2005-07-06 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 189 |
|
|---|
| 190 | * param.xweb: Replaced duplicated "charmap" IDs with good ones.
|
|---|
| 191 |
|
|---|
| 192 | 2005-07-05 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 193 |
|
|---|
| 194 | * block.xsl: branches: 1.5.2;
|
|---|
| 195 | suppress Abstract
|
|---|
| 196 |
|
|---|
| 197 | * docbook.xsl: Use utility.xsl
|
|---|
| 198 |
|
|---|
| 199 | * docbook.xsl: Implemented output-independent mechanism for gathering refentry
|
|---|
| 200 | metadata, along with a customization parameters for tuning it.
|
|---|
| 201 | (Closes #1232541)
|
|---|
| 202 |
|
|---|
| 203 | * general.xsl, info.xsl, other.xsl: Did some reorganizing.
|
|---|
| 204 |
|
|---|
| 205 | - Moved prepare.manpage.contents template out of general.xsl file
|
|---|
| 206 | and into other.xsl; general.xsl templates are now all templates
|
|---|
| 207 | that are called multiple times for each refentry, while
|
|---|
| 208 | templates in other.xsl are called only once per each refentry.
|
|---|
| 209 |
|
|---|
| 210 | - Removed get.metadata template; refentry metadata gathering is
|
|---|
| 211 | now done by common/refentry.xsl in a way that is independent of
|
|---|
| 212 | the final output format; so the common/refentry.xsl templates
|
|---|
| 213 | can be called not just by manpages stylesheets, but by
|
|---|
| 214 | stylesheets for any other output format
|
|---|
| 215 |
|
|---|
| 216 | - Added a write.man.file template. This is basically just a
|
|---|
| 217 | wrapper around the write.text.chunk template; it takes "name"
|
|---|
| 218 | and "section" params, assembles those into a filename, then
|
|---|
| 219 | passes that filename to write.text.chunk
|
|---|
| 220 |
|
|---|
| 221 | * general.xsl, utility.xsl: Renamed general.xsl to utility.xsl.
|
|---|
| 222 |
|
|---|
| 223 | * inline.xsl: Added trademark/productname template.
|
|---|
| 224 |
|
|---|
| 225 | This template causes true Unicode characters to be output for the
|
|---|
| 226 | "copyright" and "registered" symbols (which be default then get
|
|---|
| 227 | replaced by the apply-string-subst-map template). It outputs the
|
|---|
| 228 | string "(TM)" for trademark (because roff "\(tm" output is not
|
|---|
| 229 | good) and "(SM)" for servicemark.
|
|---|
| 230 |
|
|---|
| 231 | * other.xsl: Removed leftover debugging variables.
|
|---|
| 232 |
|
|---|
| 233 | * other.xsl, param.ent, param.xweb: Added support for enabling users to control what appears and does
|
|---|
| 234 | not appear in the content of the .TH title-line header/footer.
|
|---|
| 235 | (Closes #1210492)
|
|---|
| 236 |
|
|---|
| 237 | * param.ent, param.xweb: Implemented capability for users to customize "refentry metadata
|
|---|
| 238 | gathering" by specifying XPath expressions to use as "info
|
|---|
| 239 | profiles" for gathering the data, and, in some cases, to suppress
|
|---|
| 240 | parts of the data collected.
|
|---|
| 241 |
|
|---|
| 242 | * param.ent, param.xweb: Added man.subheading.divider.enabled flag and tweaked doc for
|
|---|
| 243 | man.subheading.divider
|
|---|
| 244 |
|
|---|
| 245 | * param.ent, param.xweb: Added params to support makin "metadata gathering" independent of
|
|---|
| 246 | output format (initial change for #1232541, more to follow shortly).
|
|---|
| 247 |
|
|---|
| 248 | * refentry.xsl: Cleaned up redundancies in refnamediv and refsynopsisdiv title handling.
|
|---|
| 249 |
|
|---|
| 250 | 2005-07-01 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 251 |
|
|---|
| 252 | * docbook.xsl, general.xsl, info.xsl: Checkpointing. In the middle of tinkering with composition of the
|
|---|
| 253 | .TH title line. Started pulling at thread and unwound things. This
|
|---|
| 254 | works as-is now (not broken) but is not finished.
|
|---|
| 255 |
|
|---|
| 256 | * other.xsl, refentry.xsl: Put quotes around section in .TH title line & normalize space in
|
|---|
| 257 | title and section in .TH title line (as we do with all other
|
|---|
| 258 | fields in it).
|
|---|
| 259 |
|
|---|
| 260 | Also, added and refined comments, in part based on reading of
|
|---|
| 261 | man(7) man page.
|
|---|
| 262 |
|
|---|
| 263 | 2005-06-29 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 264 |
|
|---|
| 265 | * block.xsl, general.xsl, other.xsl, param.ent, param.xweb, refentry.xsl:
|
|---|
| 266 | Added support for man.subheading.divider parameter.
|
|---|
| 267 |
|
|---|
| 268 | * docbook.xsl, other.xsl, param.ent, param.xweb: Added support for man.justify, man.hyphenate,
|
|---|
| 269 | man.break.after.slash, and an.th.title.max.length parameters.
|
|---|
| 270 | Also switch to using locale-safe "string-upper" function to
|
|---|
| 271 | uppercase the TH title. So manpages output is now
|
|---|
| 272 | internationalized/localizable in all respects where is can be made
|
|---|
| 273 | so at this point.
|
|---|
| 274 |
|
|---|
| 275 | * general.xsl, info.xsl: Deal with *info correctly & remove some kruft.
|
|---|
| 276 |
|
|---|
| 277 | * lists.xsl, other.xsl, refentry.xsl: Removed unnecessary additional linebreak that was getting added
|
|---|
| 278 | after each varlistentry. Also, in a couple places that needed it,
|
|---|
| 279 | added check for *info/title (instead of just title). Also, added
|
|---|
| 280 | support of processing title or *info/title on Refsynopsisdiv
|
|---|
| 281 | (still falls back to gentext SYNOPSIS title if no hard-coded title
|
|---|
| 282 | found.
|
|---|
| 283 |
|
|---|
| 284 | 2005-06-28 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 285 |
|
|---|
| 286 | * charmap.groff.xsl: Render servicemark and trademark as (SM) and (TM).
|
|---|
| 287 | Because console output for groff "\(tm" is not acceptable.
|
|---|
| 288 |
|
|---|
| 289 | * charmap.groff.xsl: Output "\-" for non-breaking hyphen.
|
|---|
| 290 |
|
|---|
| 291 | * docbook.xsl, param.ent, param.xweb, synop.xsl: Support man.justify and man.hyphenate params. (closes #1229225).
|
|---|
| 292 |
|
|---|
| 293 | Note that default for the both of those is zero (off), because
|
|---|
| 294 | justified text looks good only when it is also hyphenated; to
|
|---|
| 295 | quote the "Hypenation" node from the groff info page:
|
|---|
| 296 |
|
|---|
| 297 | Since the odds are not great for finding a set of words, for
|
|---|
| 298 | every output line, which fit nicely on a line without inserting
|
|---|
| 299 | excessive amounts of space between words, `gtroff' hyphenates
|
|---|
| 300 | words so that it can justify lines without inserting too much
|
|---|
| 301 | space between words.
|
|---|
| 302 |
|
|---|
| 303 | The problem is that groff is not particularly smart about how it
|
|---|
| 304 | does hyphenation; it can end up hyphenating a lot of things that
|
|---|
| 305 | you don't want hyphenated (names of symbols, for example), and it
|
|---|
| 306 | is difficult and tiresome work to prevent it from doing that. So,
|
|---|
| 307 | disabling both justification and hyphenation ensures that hyphens
|
|---|
| 308 | won't get inserted where you don't want to them, and you don't end
|
|---|
| 309 | up with lines containing excessive amounts of space between words.
|
|---|
| 310 |
|
|---|
| 311 | Yes, these default settings run counter to how most existing man
|
|---|
| 312 | pages are formatted. But there are some notable exceptions, such
|
|---|
| 313 | as the perl man pages.
|
|---|
| 314 |
|
|---|
| 315 | * other.xsl: Added support for man.output.quietly for writing of stubs.
|
|---|
| 316 | Also, added comments regarding display of .TH contents across
|
|---|
| 317 | platforms.
|
|---|
| 318 |
|
|---|
| 319 | 2005-06-27 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 320 |
|
|---|
| 321 | * docbook.xsl, general.xsl, param.ent: Implemented "character map" system for replacing Unicode
|
|---|
| 322 | characters. (closes #1226009).
|
|---|
| 323 |
|
|---|
| 324 | ::PROBLEM:
|
|---|
| 325 | The existing manpages mechanism for replacing Unicode symbols and
|
|---|
| 326 | special characters with roff equivalents is not scalable and not
|
|---|
| 327 | anywhere near as complete as it should be.
|
|---|
| 328 |
|
|---|
| 329 | For example, the mechanism currently only handles a (somewhat
|
|---|
| 330 | arbitrary) selection of less than 20 or so Unicode characters.
|
|---|
| 331 |
|
|---|
| 332 | But there are potentially more than _800_ Unicode special
|
|---|
| 333 | characters that have some groff equivalent they can be mapped to.
|
|---|
| 334 |
|
|---|
| 335 | And there are about 34 symbols in the Latin-1 (ISO-8859-1) block
|
|---|
| 336 | alone. Users might reasonably expect that if they include any of
|
|---|
| 337 | those Latin-1 characters in their DocBook source documents, they
|
|---|
| 338 | will get correctly convered to known roff equivalents in output.
|
|---|
| 339 |
|
|---|
| 340 | In addition to those common symbols, certain users may have a need
|
|---|
| 341 | to use symbols from other Unicode blocks.
|
|---|
| 342 |
|
|---|
| 343 | Say, somebody who is documenting an application related to math
|
|---|
| 344 | might need to use a bunch of symbols from the "Mathematical
|
|---|
| 345 | Operators" Unicode block (there are about 65 characters in that
|
|---|
| 346 | block that have reasonable roff equivalents).
|
|---|
| 347 |
|
|---|
| 348 | Or somebody else might really like Dingbats -- such as the
|
|---|
| 349 | checkmark character (I like that one myself) and so might use a
|
|---|
| 350 | bunch of things from the "Dingbat" block (141 characters in that
|
|---|
| 351 | that have roff equivalents or that can at least be "degraded"
|
|---|
| 352 | somewhat gracefully into roff).
|
|---|
| 353 |
|
|---|
| 354 | So we need a mechanism that is capable of handling all those 800
|
|---|
| 355 | Unicode characters that have roff equivalents -- and/or of
|
|---|
| 356 | allowing users to choose which Unicode blocks to use (through
|
|---|
| 357 | tuning the value of a parameter or something).
|
|---|
| 358 |
|
|---|
| 359 | ::FIX:
|
|---|
| 360 | Replaced the current Unicode character-substitution mechanism
|
|---|
| 361 | (replace-entities template) with a completely different
|
|---|
| 362 | character-substitution mechanism that is based on use of a
|
|---|
| 363 | "character map" (in a format compliant with the XSLT 2.0 spec and
|
|---|
| 364 | therefore completely "forward compatible" with XSLT 2.0).
|
|---|
| 365 |
|
|---|
| 366 | By default, the new "character map" mechanism does replacement of
|
|---|
| 367 | all Latin-1 symbols, along with most special spaces, dashes, and
|
|---|
| 368 | quotes (about 75 characters by default, compared to the less than
|
|---|
| 369 | 20 special characters that were handled previously). And the
|
|---|
| 370 | "full" character map provides support for converting about 800
|
|---|
| 371 | characters.
|
|---|
| 372 |
|
|---|
| 373 | The mechanism is controlled through the following parameters:
|
|---|
| 374 |
|
|---|
| 375 | - man.charmap.enabled:
|
|---|
| 376 | turns character-map support on/off
|
|---|
| 377 |
|
|---|
| 378 | - man.charmap.use.subset.xml
|
|---|
| 379 | specifies that a subset of the character map is used instead
|
|---|
| 380 | of the full character map
|
|---|
| 381 |
|
|---|
| 382 | - man.charmap.subset.profile.xml
|
|---|
| 383 | specifies profile of character-map subset
|
|---|
| 384 |
|
|---|
| 385 | - man.charmap.uri.xml
|
|---|
| 386 | specifies an alternate character map to use instead of the
|
|---|
| 387 | "standard" character map provided in the distribution
|
|---|
| 388 |
|
|---|
| 389 | For more details, see the current documention at:
|
|---|
| 390 |
|
|---|
| 391 | http://docbook.sf.net/snapshot/xsl/doc/manpages/charmap.html
|
|---|
| 392 |
|
|---|
| 393 | * param.xweb: Added IDs for sub-references, so that "human readable" filenames
|
|---|
| 394 | are generated based on those (instead of, e.g., "rn.html")
|
|---|
| 395 |
|
|---|
| 396 | * param.xweb: Made doc source compliant with expectations of doc build.
|
|---|
| 397 |
|
|---|
| 398 | 2005-06-26 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 399 |
|
|---|
| 400 | * docbook.xsl, general.xsl, info.xsl, inline.xsl, lists.xsl, other.xsl, param.ent, param.xweb, refentry.xsl, synop.xsl:
|
|---|
| 401 | Checkpointing before coding and committing final character-map changes.
|
|---|
| 402 |
|
|---|
| 403 | This change fully implements character-map support. I'll write up
|
|---|
| 404 | a longer description of that in a later commit. But the brief
|
|---|
| 405 | description is: The old Unicode character replacement mechanism
|
|---|
| 406 | (replace-entities template) has been removed; a completely
|
|---|
| 407 | different character-replacement mechanism is now used instead.
|
|---|
| 408 |
|
|---|
| 409 | By default, it does replacement of all Latin-1 symbols, along with
|
|---|
| 410 | most special spaces, dashes, and quotes (about 75 characters by
|
|---|
| 411 | default, compared to the less than 20 special characters that were
|
|---|
| 412 | handled previously). And the "full" character map provides support
|
|---|
| 413 | for converting about 800 characters. The mechanism use a
|
|---|
| 414 | "character map" (in a format compliant with the XSLT 2.0 spec and
|
|---|
| 415 | therefore completely "forward compatible" with XSLT 2.0.
|
|---|
| 416 |
|
|---|
| 417 | Other changes made for this commit:
|
|---|
| 418 |
|
|---|
| 419 | - Changed default output encoding to UTF-8.
|
|---|
| 420 |
|
|---|
| 421 | THIS DOES NOT MEAN THAT MAN PAGES ARE OUTPUT IN RAW UTF-8,
|
|---|
| 422 | because the character-map is applied before final output,
|
|---|
| 423 | causing all UTF-8 characters covered in the map to be
|
|---|
| 424 | converted to roff equivalents.
|
|---|
| 425 |
|
|---|
| 426 | - Removed code for adding backslashes before periods/dots and
|
|---|
| 427 | before hyphens (-); here's why:
|
|---|
| 428 |
|
|---|
| 429 | * Backslashes in front of periods/dots are needed only in the
|
|---|
| 430 | very rare case where a period is the very first character in
|
|---|
| 431 | a line, without any space in front of it. A better way to
|
|---|
| 432 | deal with that rare case is for authors to add a zero-width
|
|---|
| 433 | space in front of the offending dot(s) in their source
|
|---|
| 434 |
|
|---|
| 435 | * Backslashes in front of (-/-) are needed... when?
|
|---|
| 436 | Myself, I don't know, so the current stylesheet does not add
|
|---|
| 437 | backslashes in front of them, ever. If there is a specific
|
|---|
| 438 | case where they are necessary or desirable, then we need to
|
|---|
| 439 | add code for that case, not just do a blanket conversion.
|
|---|
| 440 |
|
|---|
| 441 | And, anyway, my understanding from reading the groff docs is
|
|---|
| 442 | that \- is, specifically, a _minus sign_. So if you have a
|
|---|
| 443 | place where you want a minus sign to be output instead of
|
|---|
| 444 | (-), then you should use (−/−) in your
|
|---|
| 445 | source instead. And if you have a place where you want an
|
|---|
| 446 | en dash, (–/–). Or if there are places where
|
|---|
| 447 | the stylesheets are internally generating (-) where they
|
|---|
| 448 | should be generating − or –, then we need to fix
|
|---|
| 449 | those, not just do blanket conversion.
|
|---|
| 450 |
|
|---|
| 451 | - Consolidated all bold and italic formatting so that it is done
|
|---|
| 452 | by applying the mode="bold" and mode="italic" templates.
|
|---|
| 453 |
|
|---|
| 454 | - Consolidated handling of all instances where we want to
|
|---|
| 455 | prevent line breaking; they are all now processed using the
|
|---|
| 456 | prevent.line.breaking template.
|
|---|
| 457 |
|
|---|
| 458 | - Removed "quote" template. In output, this was causing anything
|
|---|
| 459 | marked up with the <quote> element to be preceded by two
|
|---|
| 460 | backticks and followed by two apostrophes -- that is, that
|
|---|
| 461 | old-school hack for generating "curly" quotes in Emacs and in
|
|---|
| 462 | X-Windows fonts. While Emacs still seems to support that,
|
|---|
| 463 | I don't think X-Windows has for a long time now. And, anyway,
|
|---|
| 464 | it looks (and has always looked) like complete crap when
|
|---|
| 465 | viewed on a normal tty/console
|
|---|
| 466 |
|
|---|
| 467 | 2005-06-25 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 468 |
|
|---|
| 469 | * charmap.groff.xsl: Switched to "block" and "class" attributes and back to using real
|
|---|
| 470 | backslashes instead of @esc@ hack.
|
|---|
| 471 |
|
|---|
| 472 | 2005-06-20 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 473 |
|
|---|
| 474 | * charmap.groff.xsl: Added "class" attribute on all characters, value of which is the
|
|---|
| 475 | name of the Unicode block the character is from.
|
|---|
| 476 |
|
|---|
| 477 | This replaces the use of the ad-hoc "class='default'" scheme.
|
|---|
| 478 |
|
|---|
| 479 | 2005-06-14 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 480 |
|
|---|
| 481 | * charmap.groff.xml, charmap.groff.xsl, charmap.roff.min.xml, unicodetrans.xsl:
|
|---|
| 482 | More charmap reorganization.
|
|---|
| 483 |
|
|---|
| 484 | - Removed unicodetrans.xsl file (function moved to lib/lib.xsl).
|
|---|
| 485 |
|
|---|
| 486 | - Removed charmap.groff.xml & charmap.roff.min.xml and created a
|
|---|
| 487 | single charmap.groff.xsl file that incorporates both (using a
|
|---|
| 488 | class="default" attribute/value to mark those mappings that
|
|---|
| 489 | are in the default/minimal set).
|
|---|
| 490 |
|
|---|
| 491 | - Made charmap.groff.xsl into a "real" (valid) XSLT 2.0 character
|
|---|
| 492 | map so it can be used as-is for XSLT 2.0-aware processing (e.g.,
|
|---|
| 493 | it can imported or included into another XSLT 2.0 stylesheet).
|
|---|
| 494 |
|
|---|
| 495 | * docbook.xsl, other.xsl: Created an other.xsl file and moved some templates into it.
|
|---|
| 496 |
|
|---|
| 497 | * textify.xsl: Removed. No longer used by build. html/xref.xsl is used "as is"
|
|---|
| 498 |
|
|---|
| 499 | 2005-06-10 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 500 |
|
|---|
| 501 | * Makefile: Reverted some recent build changes.
|
|---|
| 502 |
|
|---|
| 503 | Reverted build of xref.xsl. Will no longer need it after Unicode
|
|---|
| 504 | char handling change is made.
|
|---|
| 505 |
|
|---|
| 506 | Reverted build of single-pass profiling stylesheet (for now). It
|
|---|
| 507 | doesn't appear to work with manpages, and figuring if and how I
|
|---|
| 508 | can get it work is a very low priority, especially given that
|
|---|
| 509 | single-pass profiling doesn't work with documents that contain
|
|---|
| 510 | xref instances. If you want to profile content before converting
|
|---|
| 511 | to man-page output, please just do a separate profiling pass first.
|
|---|
| 512 |
|
|---|
| 513 | * charmap.groff.xml, charmap.roff.min.xml, roff.charmap.xml, unicodetrans.xsl:
|
|---|
| 514 | Made further changes for Unicode character translation.
|
|---|
| 515 |
|
|---|
| 516 | Renamed roff.charmap.xml to charmap.groff.xml.
|
|---|
| 517 | Added charmap.roff.min.xml (minimal subset of around 40 "safe"
|
|---|
| 518 | mappings appropriate for nroff as opposed to groff).
|
|---|
| 519 |
|
|---|
| 520 | Removed $charmap.file param from unicodetrans.xsl in preparation
|
|---|
| 521 | for adding it as a real param to param.xweb
|
|---|
| 522 |
|
|---|
| 523 | 2005-06-09 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 524 |
|
|---|
| 525 | * general.xsl, info.xsl, synop.xsl: (devel-only issue) replace-string() -> string.subst()
|
|---|
| 526 |
|
|---|
| 527 | Removed the used-in-manpages-stylesheet-only replace-string()
|
|---|
| 528 | function and replaced all instances where it had been called with
|
|---|
| 529 | calls to the same string-substitution function used by the HTML
|
|---|
| 530 | and FO stylesheets: string.subst() from ../lib/lib.xsl
|
|---|
| 531 |
|
|---|
| 532 | * roff.charmap.xml: Corrected stray comment.
|
|---|
| 533 |
|
|---|
| 534 | * roff.charmap.xml, unicodetrans.xsl: New file.
|
|---|
| 535 |
|
|---|
| 536 | 2005-06-08 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 537 |
|
|---|
| 538 | * docbook.xsl, info.xsl: Reworked *info gathering and rethought Refclass handling.
|
|---|
| 539 |
|
|---|
| 540 | For each Refentry found, we now cache its *info and its parent's
|
|---|
| 541 | *info as node-sets; we then do all further matches against those
|
|---|
| 542 | node-sets (rather than re-selecting the original *info nodes each
|
|---|
| 543 | time we need to check them).
|
|---|
| 544 |
|
|---|
| 545 | Also, reverted the special handling of Refclass that was added
|
|---|
| 546 | recently. We eventually need to make Refclass handling consistent
|
|---|
| 547 | with that of the HTML and FO stylesheets.
|
|---|
| 548 |
|
|---|
| 549 | 2005-06-07 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 550 |
|
|---|
| 551 | * ChangeLog.20020917: New file.
|
|---|
| 552 |
|
|---|
| 553 | * README: Added some Notes section with info contributed by Barry Rountree.
|
|---|
| 554 |
|
|---|
| 555 | * README: Fixed typo.
|
|---|
| 556 |
|
|---|
| 557 | * lists.xsl: Removed unnecessary trailing comma after final term/glossterm
|
|---|
| 558 | (closes #1215890; thanks to Sam Steingold for reporting the
|
|---|
| 559 | problem).
|
|---|
| 560 |
|
|---|
| 561 | ::PROBLEM::
|
|---|
| 562 | If a varlistentry or glossentry contains multiple term or
|
|---|
| 563 | glossterm elements, a comma is rendered after the final term or
|
|---|
| 564 | glossterm. A comma should instead be rendered only after every
|
|---|
| 565 | term or glossterm _except_ the last.
|
|---|
| 566 |
|
|---|
| 567 | ::FIX::
|
|---|
| 568 | Reworked template logic for term/glossterm. They are now handled
|
|---|
| 569 | with an xsl:for-each in the varlistentry/glossentry template,
|
|---|
| 570 | rather than as separate templates.
|
|---|
| 571 |
|
|---|
| 572 | HTML and FO stylesheets appear to have the same problem, so we
|
|---|
| 573 | probably need to port this change to those as well.
|
|---|
| 574 |
|
|---|
| 575 | * refentry.xsl: Don't render NAME heading for secondary Refnamedivs (closes #1216292)
|
|---|
| 576 |
|
|---|
| 577 | If a document has multiple Refnamedivs, a NAME heading was getting
|
|---|
| 578 | rendered for each. But we only need one NAME heading. This change
|
|---|
| 579 | causes it to be rendered just once. This makes behavior in this
|
|---|
| 580 | respect consistent with how the HTML and FO stylesheets handle the
|
|---|
| 581 | generated NAME heading for Refnamediv.
|
|---|
| 582 |
|
|---|
| 583 | 2005-06-06 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 584 |
|
|---|
| 585 | * refentry.xsl: Uppercase titles in x-ref to Refentry children (closes #1215547;
|
|---|
| 586 | thanks to Jens Granseuer for reporting the problem).
|
|---|
| 587 |
|
|---|
| 588 | ::PROBLEM::
|
|---|
| 589 | Titles of all first-level sections in man pages are always
|
|---|
| 590 | rendered in uppercase. But cross-references to those titles are
|
|---|
| 591 | not uppercase.
|
|---|
| 592 |
|
|---|
| 593 | ::FIX::
|
|---|
| 594 | Cross-references to titles of all first-level sections of Refentry
|
|---|
| 595 | output are now rendered in uppercase; that is, titles in x-refs to
|
|---|
| 596 | Refnamediv, Refsynopsisdiv, Refsect1, and any Refsection that is a
|
|---|
| 597 | direct child of Refentry.
|
|---|
| 598 |
|
|---|
| 599 | Also, x-ref to Refnamediv now uses the localized "NAME" title
|
|---|
| 600 | instead of the using the first Refname child. This makes the
|
|---|
| 601 | output inconsistent with HTML and FO output, but for man-page
|
|---|
| 602 | output, it seems to make better sense to have the "NAME". (It may
|
|---|
| 603 | actually make better sense to do it that way in HTML and FO output
|
|---|
| 604 | as well.) That said, I guess it's not likely that most people
|
|---|
| 605 | would put in an x-ref to a Refnamediv section, so maybe it's kind
|
|---|
| 606 | of a moot point...
|
|---|
| 607 |
|
|---|
| 608 | 2005-06-02 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 609 |
|
|---|
| 610 | * general.xsl, synop.xsl: Added support for processing funcparams (closes #1213166; thanks
|
|---|
| 611 | to Barry Rountree for reporting).
|
|---|
| 612 |
|
|---|
| 613 | ::PROBLEM::
|
|---|
| 614 | The funcparams element was not being processed as expected.
|
|---|
| 615 |
|
|---|
| 616 | ::CAUSE::
|
|---|
| 617 | No logic existed in manpages stylesheets for handling funcparams.
|
|---|
| 618 |
|
|---|
| 619 | ::FIX::
|
|---|
| 620 | Fixed by taking old code for handling of funcprototype and
|
|---|
| 621 | children, and replacing it with code ported over from HTML
|
|---|
| 622 | templates for ANSI-style output.
|
|---|
| 623 |
|
|---|
| 624 | ::AFFECTS::
|
|---|
| 625 | This change affects handling of all funcprototype output. Along
|
|---|
| 626 | with adding support for funcparams, the following changes were
|
|---|
| 627 | also made:
|
|---|
| 628 |
|
|---|
| 629 | - removed the space that was being output between funcdef and
|
|---|
| 630 | paramdef; example:
|
|---|
| 631 |
|
|---|
| 632 | was: float rand (void);
|
|---|
| 633 | now: float rand(void);
|
|---|
| 634 |
|
|---|
| 635 | - turned off bold formatting for the <type> element when it
|
|---|
| 636 | occurs within a funcdef or paramdef
|
|---|
| 637 |
|
|---|
| 638 | - moved space -> nobreak-space replacement logic into a separate
|
|---|
| 639 | template (for potential re-use elsewhere if we need it)
|
|---|
| 640 |
|
|---|
| 641 | ::TODO::
|
|---|
| 642 | We need to add an option for K&R style funcprototypes.
|
|---|
| 643 | See #1213277.
|
|---|
| 644 |
|
|---|
| 645 | http://sourceforge.net/tracker/index.php?func=detail&aid=1213277&group_id=21935&atid=516914
|
|---|
| 646 |
|
|---|
| 647 | 2005-05-30 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 648 |
|
|---|
| 649 | * docbook.xsl, info.xsl: Re-worked construction of .TH title line (closes #1210488).
|
|---|
| 650 | Also, made comment generated at top of page include version info
|
|---|
| 651 | (closes #1211254).
|
|---|
| 652 |
|
|---|
| 653 | Here are the details about the refinements made to the
|
|---|
| 654 | construction of the .TH title line:
|
|---|
| 655 |
|
|---|
| 656 | - "extra1" (which shows up in the center footer of each page):
|
|---|
| 657 | If a date cannot be found in the source, we now automatically
|
|---|
| 658 | generate a localized "long format" date
|
|---|
| 659 |
|
|---|
| 660 | - "extra2" (which shows up in the left footer):
|
|---|
| 661 | We now first search for "product version" info; then, if we
|
|---|
| 662 | can't find that, a "product name"; if we can't find that, we
|
|---|
| 663 | look for "other" info to use. And we can't find that, we leave
|
|---|
| 664 | it empty. The exact sequence of elements checked is this:
|
|---|
| 665 |
|
|---|
| 666 | 1. productnumber in info or refentryinfo
|
|---|
| 667 | 2. productnumber in info or referenceinfo of parent reference
|
|---|
| 668 | 3. any refmeta/refmiscinfo that has class = 'version'
|
|---|
| 669 | 4. productname in info or refentryinfo
|
|---|
| 670 | 5. productname in info or referenceinfo of parent reference
|
|---|
| 671 | 6. refmeta/refmiscinfo (first one)
|
|---|
| 672 | 7. refnamediv/refclass (first one)
|
|---|
| 673 |
|
|---|
| 674 | - "extra3" (which shows up in the center header):
|
|---|
| 675 | The exact sequence of elements checked is now this:
|
|---|
| 676 |
|
|---|
| 677 | 1. title in info or referenceinfo of parent reference
|
|---|
| 678 | 2. refnamediv/refclass (first one)
|
|---|
| 679 | 3. refmeta/refmiscinfo (first one)
|
|---|
| 680 |
|
|---|
| 681 | 2005-05-29 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 682 |
|
|---|
| 683 | * general.xsl, refentry.xsl: Added support for processing refsection down to any arbitrary
|
|---|
| 684 | level of nesting (closes #1210482).
|
|---|
| 685 |
|
|---|
| 686 | * stripns.xsl: New file.
|
|---|
| 687 |
|
|---|
| 688 | * stripns.xsl: Fixed typo in comment.
|
|---|
| 689 |
|
|---|
| 690 | 2005-05-28 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 691 |
|
|---|
| 692 | * block.xsl, docbook.xsl, general.xsl, refentry.xsl: Added support for refsect3 and formalpara processing (closes
|
|---|
| 693 | #1210478 and #1210479).
|
|---|
| 694 |
|
|---|
| 695 | Also did some further templates re-organizing, including to the
|
|---|
| 696 | logic for gathering and processing metadata.
|
|---|
| 697 |
|
|---|
| 698 | 2005-05-27 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 699 |
|
|---|
| 700 | * block.xsl, docbook.xsl, general.xsl, inline.xsl: Modularized a bit further.
|
|---|
| 701 |
|
|---|
| 702 | * block.xsl, lists.xsl, synop.xsl, textify.xsl: Added header (with RCS keywords and copyright info) to all files
|
|---|
| 703 | that lacked it.
|
|---|
| 704 |
|
|---|
| 705 | * docbook.xsl: Modularized main "refentry" template a bit.
|
|---|
| 706 |
|
|---|
| 707 | * sect23.xsl: Removed. This file has never been included by docbook.xsl, so it
|
|---|
| 708 | serves no purpose at all...
|
|---|
| 709 |
|
|---|
| 710 | 2005-05-24 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 711 |
|
|---|
| 712 | * .cvsignore, Makefile, textify.xsl, xref.xsl: Make xrefs and olinks work, and prevent instances of “ and
|
|---|
| 713 | ” entities in output (closes #741578 and #956072; thanks to
|
|---|
| 714 | Jens Granseuer and Sam Steingold for reporting the problems)
|
|---|
| 715 |
|
|---|
| 716 | ::Problem:
|
|---|
| 717 | If you include an xref in a source document, instead of getting
|
|---|
| 718 | the xref text you would expect in the output, you just get
|
|---|
| 719 | "[xref to refsect1]", where "refsect" is the name of the target
|
|---|
| 720 | element for the xref. If you include an olink, it works as
|
|---|
| 721 | expected -- except that the output text has “ and ”
|
|---|
| 722 | entities (double "curly" quotation marks).
|
|---|
| 723 |
|
|---|
| 724 | ::Cause:
|
|---|
| 725 | The manpages/docbook.xsl driver imports the html/docbook.xsl
|
|---|
| 726 | stylesheet, which in turn imports the html/xref.xsl file.
|
|---|
| 727 |
|
|---|
| 728 | The manpages/docbook.xsl file then imports the manpages/xref.xsl
|
|---|
| 729 | file. That file contains a "xref" template that overrides the
|
|---|
| 730 | the one in html/xref.xsl and that, by design, does nothing
|
|---|
| 731 | except to generate the "[xref to refsect1]" text instead of the
|
|---|
| 732 | expected xref output.
|
|---|
| 733 |
|
|---|
| 734 | On the other hand, the manpages stylesheets don't override the
|
|---|
| 735 | "olink" template; therefore, the "olink" template from the
|
|---|
| 736 | html/xref.xsl file is used "as is". And being that it is
|
|---|
| 737 | intended for HTML output, that template uses the “ and
|
|---|
| 738 | ” to wrap titles in xref output.
|
|---|
| 739 |
|
|---|
| 740 | ::Fix:
|
|---|
| 741 | The original manpages/xref.xsl file has now been removed. The
|
|---|
| 742 | build for the manpages distribution now makes that file, using
|
|---|
| 743 | the textify.xsl stylesheet to automatically generate it from the
|
|---|
| 744 | html/xref.xsl file. It is built in such a away that it basically
|
|---|
| 745 | just contains special copies of the "xref" and "olink" templates
|
|---|
| 746 | that cause “ and ” instances to be transformed into
|
|---|
| 747 | "\(lq" and "\(rq" (groff "left quote" and "right quote").
|
|---|
| 748 |
|
|---|
| 749 | It might seem odd that templates from the html/xref.xsl are
|
|---|
| 750 | used, since those templates a designed to generate hyperlinks of
|
|---|
| 751 | the form <a href="#foo">the section called "Bar"</a>. But it
|
|---|
| 752 | works because the manpages stylesheets end up using the text
|
|---|
| 753 | value of the output of the above. Thus, the <a href="#foo"> and
|
|---|
| 754 | </a> parts are stripped out, leaving just the text between
|
|---|
| 755 | ('the section called "Bar"').
|
|---|
| 756 |
|
|---|
| 757 | ::Affects
|
|---|
| 758 | Only affects output of xref and olink elements. The fix may not
|
|---|
| 759 | be complete and/or may cause other problems. Please test.
|
|---|
| 760 |
|
|---|
| 761 | In particular, while it may fix the “ and ” problem
|
|---|
| 762 | that English lang/locales users have run into, it doesn't fix
|
|---|
| 763 | the corresponding problem for output of xrefs and olinks in many
|
|---|
| 764 | non-English locales, which use quoting characters other than
|
|---|
| 765 | “ and ”
|
|---|
| 766 |
|
|---|
| 767 | To give just one example of many: in Japanese, the quoting
|
|---|
| 768 | characters are 「 and 」 ("left corner bracket" and
|
|---|
| 769 | "right corner bracket"). It is possible to "fix" the problem for
|
|---|
| 770 | all locales; but it is just a question of whether there is
|
|---|
| 771 | enough of a demand for it that it is worth doing.
|
|---|
| 772 |
|
|---|
| 773 | * Makefile: Cause "clean" target to remove xref.xsl
|
|---|
| 774 |
|
|---|
| 775 | * docbook.xsl: Whitespace-only change. Expanded all tabs
|
|---|
| 776 |
|
|---|
| 777 | * docbook.xsl: Added replace-ldqou and replace-rdquo templates, for translating
|
|---|
| 778 | “ to \(lq and ” to \(rq
|
|---|
| 779 |
|
|---|
| 780 | * docbook.xsl, sect23.xsl, synop.xsl: Prevent "sticky" fonts changes. (closes #956070; thanks to Sam
|
|---|
| 781 | Steingold for reporting the problem, and for his patience...)
|
|---|
| 782 |
|
|---|
| 783 | ::Problem:
|
|---|
| 784 | Sometimes a bold or italic font change inadvertently ends up
|
|---|
| 785 | becoming "sticky" such that a following chunk of text that
|
|---|
| 786 | should just be rendered as plain text instead gets
|
|---|
| 787 | boldfaced/italicized.
|
|---|
| 788 |
|
|---|
| 789 | ::Cause:
|
|---|
| 790 | Font changes were simply being nested, as they are in HTML.
|
|---|
| 791 | While that works for HTML, it doesn't work for roff, where
|
|---|
| 792 | font-change instructions aren't actually intended to nest.
|
|---|
| 793 |
|
|---|
| 794 | ::Fix:
|
|---|
| 795 | Attempted to un-nest bold/italic font changes. When the manpages
|
|---|
| 796 | stylesheets encounter node sets that need to be boldfaced or
|
|---|
| 797 | italicized, they now put the \fBfoo\fR \fIbar\fR groff
|
|---|
| 798 | bold/italic instructions separately around each node in the set.
|
|---|
| 799 |
|
|---|
| 800 | This may not be a complete fix for the problem. In fact, it may
|
|---|
| 801 | cause other problems. Please test :^)
|
|---|
| 802 |
|
|---|
| 803 | * lists.xsl: Support generation of choice separator in inline simplelist
|
|---|
| 804 | (closes #1207532)
|
|---|
| 805 |
|
|---|
| 806 | This ehancement enables auto-generation of an appropriate
|
|---|
| 807 | localized "choice separator" (for example, "and" or
|
|---|
| 808 | "or") before the final item in an inline simplelist.
|
|---|
| 809 |
|
|---|
| 810 | To indicate that you want a choice separator generated
|
|---|
| 811 | for a particular list, you need to put a processing
|
|---|
| 812 | instruction (PI) of the form <?dbchoice choice="foo"?>
|
|---|
| 813 | as a child a of the list. For example:
|
|---|
| 814 |
|
|---|
| 815 | <para>This release adds localiation support for the
|
|---|
| 816 | following Indic languages:
|
|---|
| 817 | <simplelist type="inline">
|
|---|
| 818 | <?dbchoice choice="and" ?>
|
|---|
| 819 | <member>Hindi</member>
|
|---|
| 820 | <member>Punjabi</member>
|
|---|
| 821 | <member>Tamil</member>
|
|---|
| 822 | <member>Oriya</member>
|
|---|
| 823 | <member>Gujarati</member>
|
|---|
| 824 | </simplelist>.
|
|---|
| 825 | </para>
|
|---|
| 826 |
|
|---|
| 827 | Output (for English):
|
|---|
| 828 |
|
|---|
| 829 | This release adds localiation support for the
|
|---|
| 830 | following Indic languages: Hindi, Punjabi, Tamil,
|
|---|
| 831 | Oriya, and Gujarati.
|
|---|
| 832 |
|
|---|
| 833 | Or if the logical relationship between the items in the
|
|---|
| 834 | list is an "or" relationship, then use choice="or":
|
|---|
| 835 |
|
|---|
| 836 | <para>Choose from ONE and ONLY ONE of the following:
|
|---|
| 837 | <simplelist type="inline">
|
|---|
| 838 | <?dbchoice choice="or" ?>
|
|---|
| 839 | <member>A</member>
|
|---|
| 840 | <member>B</member>
|
|---|
| 841 | <member>C</member>.
|
|---|
| 842 | </simplelist>
|
|---|
| 843 | </para>
|
|---|
| 844 |
|
|---|
| 845 | Output (for English):
|
|---|
| 846 |
|
|---|
| 847 | Choose from ONE and only ONE of the
|
|---|
| 848 | following choices: A, B, or C.
|
|---|
| 849 |
|
|---|
| 850 | As a temporary workaround for the fact that most of the
|
|---|
| 851 | DocBook non-English locale files don't have a
|
|---|
| 852 | localization for the word "or", you can put in a
|
|---|
| 853 | literal string to be used; example for French:
|
|---|
| 854 |
|
|---|
| 855 | <para>Choose from ONE and ONLY ONE of the following:
|
|---|
| 856 | <simplelist type="inline">
|
|---|
| 857 | <?dbchoice choice="ou" ?>
|
|---|
| 858 | <member>A</member>
|
|---|
| 859 | <member>B</member>
|
|---|
| 860 | <member>C</member>.
|
|---|
| 861 | </simplelist>
|
|---|
| 862 | </para>
|
|---|
| 863 |
|
|---|
| 864 | That is, use "ou" instead of "or".
|
|---|
| 865 |
|
|---|
| 866 | 2005-05-23 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 867 |
|
|---|
| 868 | * synop.xsl: Rolled back some over-aggressive line-break cleanup, and removed
|
|---|
| 869 | space-normalizing call in group|arg template because it causes
|
|---|
| 870 | <sbr/> to be handled incorrectly.
|
|---|
| 871 |
|
|---|
| 872 | 2005-05-22 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 873 |
|
|---|
| 874 | * docbook.xsl: Grand Unification: Epilogue (2): If "neighboring" text nodes in
|
|---|
| 875 | mixed content are whitespace-only, apply the special sauce just
|
|---|
| 876 | before serving; that is, at the end, not both at the beginning and
|
|---|
| 877 | at the end.
|
|---|
| 878 |
|
|---|
| 879 | * lists.xsl: Repaired line-breaking in list output. Thanks to Hendrik Sattler
|
|---|
| 880 | for reporting the problem.
|
|---|
| 881 |
|
|---|
| 882 | The cause of this is was a change that was made a while back to
|
|---|
| 883 | reduce excessive blank lines in output. Looks like in this case it
|
|---|
| 884 | cut it back a bit too aggressively. There may yet be some other
|
|---|
| 885 | cases that will need more fine-tuning.
|
|---|
| 886 |
|
|---|
| 887 | 2005-05-21 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 888 |
|
|---|
| 889 | * docbook.xsl: Whitespace Grand Unification: Epilogue (1): If "neighboring" text
|
|---|
| 890 | nodes in mixed content are whitespace-only, leave them unseasoned;
|
|---|
| 891 | that is, don't add the special sauce.
|
|---|
| 892 |
|
|---|
| 893 | 2005-05-20 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 894 |
|
|---|
| 895 | * docbook.xsl, lists.xsl, synop.xsl: Verbatim environment "Grand Unification" fix.
|
|---|
| 896 |
|
|---|
| 897 | Attempte to fix handling of verbatim environments (literallayout,
|
|---|
| 898 | programlisting, screen) and, in a related way, text nodes.
|
|---|
| 899 | Particularly in mixed-content blocks. I think I got it working...
|
|---|
| 900 |
|
|---|
| 901 | Closes #1167995, #975243, #935833, #763861, #728932, #628393, #595213.
|
|---|
| 902 |
|
|---|
| 903 | Thanks to Hendrik Sattler, Tobias Reif, Tommi Virtanen, Dennis
|
|---|
| 904 | Grace, and Matthias Andree for reporting the problems.
|
|---|
| 905 |
|
|---|
| 906 | Sorry it took so long for the fix.
|
|---|
| 907 |
|
|---|
| 908 | 2005-05-11 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 909 |
|
|---|
| 910 | * docbook.xsl: remove some unnecessary generated line breaks (relates to issue #607270)
|
|---|
| 911 |
|
|---|
| 912 | * docbook.xsl: Handle email in info section apprpropriately.
|
|---|
| 913 | Replace "Man page edited by Foo." with "Foo. (man page)"
|
|---|
| 914 |
|
|---|
| 915 | * lists.xsl: Simplified and corrected rendering of simplelist. (closes #1154750
|
|---|
| 916 | and #699081; thanks to Matthias Andree and Bert Vermeulen for
|
|---|
| 917 | reporting the problem)
|
|---|
| 918 |
|
|---|
| 919 | - Any simplelist type="inline" instance is now rendered as a
|
|---|
| 920 | comma-separated list, with a comma and also a localized "and"
|
|---|
| 921 | before the last item.
|
|---|
| 922 |
|
|---|
| 923 | - Any simplelist instance whose type is not inline is rendered
|
|---|
| 924 | as a one-column vertical list (ignoring the values of the type
|
|---|
| 925 | and columns attributes if present)
|
|---|
| 926 |
|
|---|
| 927 | * lists.xsl, sect23.xsl, synop.xsl: removed some more unnecessary line breaks (closes #607270)
|
|---|
| 928 |
|
|---|
| 929 | 2005-05-10 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 930 |
|
|---|
| 931 | * docbook.xsl: Support localization of gentext for various things (issue
|
|---|
| 932 | #1199352, #1199153, #1199033, and #1167995; thanks to Hendrik
|
|---|
| 933 | Sattler for reporting the issue).
|
|---|
| 934 |
|
|---|
| 935 | Gentext is now localized for the following
|
|---|
| 936 |
|
|---|
| 937 | - Heading generated for refsynopsis section
|
|---|
| 938 | - Heading generated for refname section
|
|---|
| 939 | - Heading generated for author attribution
|
|---|
| 940 | - Headings generated for admontions
|
|---|
| 941 |
|
|---|
| 942 | There are some other bits of gentext that still need to be
|
|---|
| 943 | localized.
|
|---|
| 944 |
|
|---|
| 945 | 2005-02-24 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 946 |
|
|---|
| 947 | * .cvsignore: ignore stuff
|
|---|
| 948 |
|
|---|
| 949 | * .cvsignore: New file.
|
|---|
| 950 |
|
|---|
| 951 | * Makefile, param.ent, param.xweb: New file.
|
|---|
| 952 |
|
|---|
| 953 | * docbook.xsl: revert misguided dependence on emphasis.propagates.style in
|
|---|
| 954 | manpages output; manpages are now just hard-coded (not
|
|---|
| 955 | configurable) to turn emphasis into groff italic and emphasis
|
|---|
| 956 | role=bold|strong into groff bold; this is equivalent to what is
|
|---|
| 957 | done for HTML output; should it be configurable?
|
|---|
| 958 |
|
|---|
| 959 | 2005-02-10 Robert Stayton <bobstayton@users.sourceforge.net>
|
|---|
| 960 |
|
|---|
| 961 | * synop.xsl: Fixed sbr template to output .br.
|
|---|
| 962 |
|
|---|
| 963 | 2004-11-22 <twaugh@users.sourceforge.net>
|
|---|
| 964 |
|
|---|
| 965 | * docbook.xsl: Use ASCII escape sequence for ' '.
|
|---|
| 966 |
|
|---|
| 967 | 2004-10-21 Michael Smith <xmldoc@users.sourceforge.net>
|
|---|
| 968 |
|
|---|
| 969 | * docbook.xsl: Bug #1049155 (support Emphasis tag in man/groff output)
|
|---|
| 970 |
|
|---|
| 971 | Added support for converting <emphasis>foo</emphasis> to groff italic
|
|---|
| 972 | and <emphasis role='bold'>foo</emphasis> to bold.
|
|---|
| 973 |
|
|---|
| 974 | Controlled by emphasis.propagates.style param, but not documented
|
|---|
| 975 | yet using litprog system. Will do that next (planning to add some
|
|---|
| 976 | other parameter-controllable options for hyphenation and
|
|---|
| 977 | handling of line spacing).
|
|---|
| 978 |
|
|---|
| 979 | 2004-02-04 <twaugh@users.sourceforge.net>
|
|---|
| 980 |
|
|---|
| 981 | * docbook.xsl, lists.xsl: Place-holder implementation for simplelist.
|
|---|
| 982 |
|
|---|
| 983 | 2004-01-30 <twaugh@users.sourceforge.net>
|
|---|
| 984 |
|
|---|
| 985 | * docbook.xsl: Add replacement dingbat characters.
|
|---|
| 986 |
|
|---|
| 987 | 2003-12-24 <twaugh@users.sourceforge.net>
|
|---|
| 988 |
|
|---|
| 989 | * lists.xsl: .RS/.RE doesn't nest precisely. Use .IP to fix up the environment. Part of
|
|---|
| 990 | bug #852714.
|
|---|
| 991 |
|
|---|
| 992 | * lists.xsl: Handle comments inside lists (part of bug #852714).
|
|---|
| 993 |
|
|---|
| 994 | 2003-12-15 <twaugh@users.sourceforge.net>
|
|---|
| 995 |
|
|---|
| 996 | * lists.xsl: Fix nested lists properly.
|
|---|
| 997 |
|
|---|
| 998 | 2003-12-13 <twaugh@users.sourceforge.net>
|
|---|
| 999 |
|
|---|
| 1000 | * docbook.xsl: Use .nf environment for literallayout.
|
|---|
| 1001 |
|
|---|
| 1002 | * docbook.xsl: Prevent duplicate .nf environments inside informalexample or screen. All
|
|---|
| 1003 | fiftenn allowed contained element in these elements will provide its own.
|
|---|
| 1004 |
|
|---|
| 1005 | 2003-12-12 <twaugh@users.sourceforge.net>
|
|---|
| 1006 |
|
|---|
| 1007 | * docbook.xsl: Last commit reverted a previous change -- redo it.
|
|---|
| 1008 |
|
|---|
| 1009 | 2003-12-11 <twaugh@users.sourceforge.net>
|
|---|
| 1010 |
|
|---|
| 1011 | * docbook.xsl: Remove unused rule.
|
|---|
| 1012 |
|
|---|
| 1013 | * docbook.xsl: Fix literallayout inside para.
|
|---|
| 1014 |
|
|---|
| 1015 | * lists.xsl: Fix singly-nested lists.
|
|---|
| 1016 |
|
|---|
| 1017 | 2003-12-10 <twaugh@users.sourceforge.net>
|
|---|
| 1018 |
|
|---|
| 1019 | * docbook.xsl: Don't mess up roff markup in tables.
|
|---|
| 1020 |
|
|---|
| 1021 | 2003-11-06 <twaugh@users.sourceforge.net>
|
|---|
| 1022 |
|
|---|
| 1023 | * lists.xsl, synop.xsl: 2003-11-06 Tim Waugh <twaugh@redhat.com>
|
|---|
| 1024 |
|
|---|
| 1025 | * lists.xsl: Normalize space in itemizedlist/listitem.
|
|---|
| 1026 | * synop.xsl: Likewise.
|
|---|
| 1027 |
|
|---|
| 1028 | 2003-05-23 <twaugh@users.sourceforge.net>
|
|---|
| 1029 |
|
|---|
| 1030 | * synop.xsl: Only escape option spaces once when args are nested.
|
|---|
| 1031 |
|
|---|
| 1032 | 2003-05-15 <twaugh@users.sourceforge.net>
|
|---|
| 1033 |
|
|---|
| 1034 | * docbook.xsl: Handle refsection as well as refsect1|refsect2 in the manpages stylesheet.
|
|---|
| 1035 |
|
|---|
| 1036 | 2003-05-09 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1037 |
|
|---|
| 1038 | * synop.xsl, synop.xsl: Patch from Tim Waugh
|
|---|
| 1039 |
|
|---|
| 1040 | 2003-04-12 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1041 |
|
|---|
| 1042 | * docbook.xsl, synop.xsl: Patches from Tim Waugh
|
|---|
| 1043 |
|
|---|
| 1044 | 2003-03-15 <jorton@users.sourceforge.net>
|
|---|
| 1045 |
|
|---|
| 1046 | * docbook.xsl: If the refmeta contains no manvolnum, then:
|
|---|
| 1047 | - if the refentry contains a funcsynopsis, default to section 3
|
|---|
| 1048 | - otherwise, default to section 1
|
|---|
| 1049 |
|
|---|
| 1050 | * docbook.xsl: Don't try and generate man pages with spaces in the filename; replace
|
|---|
| 1051 | spaces with underscores.
|
|---|
| 1052 |
|
|---|
| 1053 | 2003-01-05 <jorton@users.sourceforge.net>
|
|---|
| 1054 |
|
|---|
| 1055 | * docbook.xsl: Second half of fix for #628888: add template for <optional>.
|
|---|
| 1056 |
|
|---|
| 1057 | * docbook.xsl: Add replacement ulink template from xmlto, fixing bug #619500.
|
|---|
| 1058 | Written by Tim Waugh.
|
|---|
| 1059 |
|
|---|
| 1060 | * docbook.xsl: First part of fix for #628888:
|
|---|
| 1061 | - don't use generic italic/bold templates for things like <replaceable>,
|
|---|
| 1062 | since <replaceable> can contain other elements, but the templates discard
|
|---|
| 1063 | any non-PCDATA content.
|
|---|
| 1064 |
|
|---|
| 1065 | * docbook.xsl: Prevent a line beginning with a '.' character being interpreted as a
|
|---|
| 1066 | troff macro by inserting \& (a zero-width space) before every '.' in text.
|
|---|
| 1067 |
|
|---|
| 1068 | * xref.xsl: Make xref work again, though I'm not sure why it stopped working.
|
|---|
| 1069 |
|
|---|
| 1070 | 2002-09-20 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1071 |
|
|---|
| 1072 | * synop.xsl: Joe Orton: Use replace-string from lib.xsl
|
|---|
| 1073 |
|
|---|
| 1074 | 2002-09-18 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1075 |
|
|---|
| 1076 | * db2man.xsl, docbook.xsl: Renamed
|
|---|
| 1077 |
|
|---|
| 1078 | * docbook.xsl: Joe Orton: patch to get rid of extra whitespace in author names
|
|---|
| 1079 |
|
|---|
| 1080 | 2002-09-17 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1081 |
|
|---|
| 1082 | * db2man.xsl: Another patch from Joe Orton
|
|---|
| 1083 |
|
|---|
| 1084 | * db2man.xsl, synop.xsl: Patch from Joe Orton
|
|---|
| 1085 |
|
|---|
| 1086 | 2002-07-04 Norman Walsh <nwalsh@users.sourceforge.net>
|
|---|
| 1087 |
|
|---|
| 1088 | * README, db2man.xsl, lists.xsl, sect23.xsl, synop.xsl, xref.xsl:
|
|---|
| 1089 | Initial checkins; moved from contrib by nwalsh
|
|---|
| 1090 |
|
|---|
