├── LICENSE ├── Makefile ├── README ├── README.orig ├── autoload └── tex_nine.vim ├── doc ├── latexhelp.txt └── tex_nine.txt ├── ftplugin ├── bib_nine.vim ├── tex_nine.vim └── tex_nine │ ├── __init__.py │ ├── evince_dbus.py │ ├── skeleton │ ├── tex_skeleton.tex.latex │ ├── tex_skeleton.tex.make │ ├── tex_skeleton.tex.pdflatex │ └── tex_skeleton.tex.xelatex │ ├── snippets │ ├── bib_snippets.snippets │ └── tex_snippets.snippets │ ├── tex_dictionary.txt │ ├── tex_nine_common.vim │ ├── tex_nine_symbols.py │ ├── tex_nine_synctex.py │ └── tex_nine_utils.py └── indent └── tex.vim /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | 2 | VERSION=`git describe` 3 | PROGRAM=tex_nine 4 | NAME=$(PROGRAM)-$(VERSION) 5 | 6 | all: 7 | git archive --prefix=$(NAME)/ -o $(NAME).tar.gz -9 $(VERSION) 8 | 9 | -------------------------------------------------------------------------------- /README: -------------------------------------------------------------------------------- 1 | This is a mirror of http://www.vim.org/scripts/script.php?script_id=3508 2 | 3 | TeX-9 4 | 5 | Author: Elias Toivanen 6 | License: GPL 7 | Version: 1.3.13 8 | 9 | TeX-9 is a ftplugin that aims to enhance the writing experience of high 10 | quality documents with LaTeX and Vim. The goal of TeX-9 is to be simple 11 | and Vimish, meaning that focus is on carefully thought-out key mappings 12 | and features that are already present in a typical Vim installation. If 13 | you need to write a thesis or research articles and insist on having only 14 | one editor for all editing tasks, then TeX-9 is for you! 15 | 16 | TeX-9 uses Python2.x as its backend and therefore a Vim installation with 17 | Python support is required. TeX-9 is being developed on Linux running 18 | Vim 7.4. 19 | 20 | The main features of TeX-9 are 21 | * Compile, debug and launch a document viewer from within Vim 22 | * Insert LaTeX code snippets with ease 23 | * Powerful text-object for LaTeX environments 24 | * Omni-completion of BibTeX database entries and label references 25 | * Omni-completion of mathematical symbols 26 | * SyncTeX support (for the Evince document viewer) 27 | * Filetype specific indentation (courtesy of Johannes Tanzler) 28 | * LaTeX2e manual (ported to Vim by Mikolaj Machowski) 29 | * No-hassle settings, relatively few mappings 30 | 31 | ============================================================================== 32 | 33 | -------------------------------------------------------------------------------- /README.orig: -------------------------------------------------------------------------------- 1 | 2 | TeX-9 3 | 4 | A semi-automatic, prefix-operated 5 | TeX ftplugin 6 | with lots of firepower! 7 | 8 | Author: Elias Toivanen 9 | Email: [1] 10 | License: GPL 11 | Version: 1.3.13 12 | 13 | TeX-9 is a ftplugin that aims to enhance the writing experience of high 14 | quality documents with LaTeX and Vim. The goal of TeX-9 is to be simple 15 | and Vimish, meaning that focus is on carefully thought-out key mappings 16 | and features that are already present in a typical Vim installation. If 17 | you need to write a thesis or research articles and insist on having only 18 | one editor for all editing tasks, then TeX-9 is for you! 19 | 20 | TeX-9 uses Python2.x as its backend and therefore a Vim installation with 21 | Python support is required. TeX-9 is being developed on Linux running 22 | Vim 7.4 23 | 24 | The main features of TeX-9 are 25 | * Compile, debug and launch a document viewer from within Vim 26 | * Insert LaTeX code snippets with ease 27 | * Powerful text-object for LaTeX environments 28 | * Omni-completion of BibTeX database entries and label references 29 | * Omni-completion of mathematical symbols 30 | * SyncTeX support (for the Evince document viewer) 31 | * Filetype specific indentation (courtesy of Johannes Tanzler) 32 | * LaTeX2e manual (ported to Vim by Mikolaj Machowski) 33 | * No-hassle settings, relatively few mappings 34 | 35 | ============================================================================== 36 | 37 | 1. Quick help for installation 38 | 39 | * Unzip the tarball to your local Vim tree (usually ~/.vim) 40 | * Update helptags (:helptags ~/.vim/doc/) 41 | * Read the help on TeX-9 (:help tex_nine) 42 | 43 | ============================================================================== 44 | 45 | [1] http://www.google.com/recaptcha/mailhide/d?k=01zYGjcmroKw0SapWSzBKoIQ==&c=a4IzT40CjKv-Rc9xXg4HCrD2AUf-Ku8Qb77II5iVomQ= 46 | 47 | ============================================================================== 48 | 49 | vim:tw=72:ts=8:norl 50 | 51 | 52 | -------------------------------------------------------------------------------- /autoload/tex_nine.vim: -------------------------------------------------------------------------------- 1 | " vim: tw=72 2 | 3 | "*********************************************************************** 4 | " General purpose routines 5 | "*********************************************************************** 6 | 7 | function tex_nine#GetMaster() 8 | python << EOF 9 | try: 10 | master_file = document.get_master_file(vim.current.buffer) 11 | except TeXNineError, e: 12 | echoerr(e) 13 | master_file = "" 14 | EOF 15 | return pyeval('master_file') 16 | endfunction 17 | 18 | function tex_nine#GetOutputFile() 19 | python << EOF 20 | master_output = "" 21 | try: 22 | master_output = document.get_master_output(vim.current.buffer) 23 | except TeXNineError, e: 24 | echoerr(e) 25 | master_output = "" 26 | EOF 27 | return pyeval('master_output') 28 | endfunction 29 | 30 | function tex_nine#GetCompiler(config) 31 | 32 | " The mode line takes precedence 33 | silent! let tex_nine_compiler = pyeval('document.get_compiler(vim.current.buffer)') 34 | 35 | " The compiler was set in vimrc 36 | if tex_nine_compiler == "" && a:config.compiler != "" 37 | let tex_nine_compiler = a:config.compiler 38 | endif 39 | 40 | " Side effect: configure the compilation flags 41 | if &l:makeprg == "" && tex_nine_compiler != "" 42 | call tex_nine#ConfigureCompiler(tex_nine_compiler, a:config.synctex, a:config.shell_escape, a:config.extra_args) 43 | endif 44 | 45 | return tex_nine_compiler 46 | 47 | endfunction 48 | 49 | 50 | "*********************************************************************** 51 | " Viewing and SyncTeXing 52 | "*********************************************************************** 53 | 54 | function tex_nine#ViewDocument() 55 | echo "Viewing the document...\r" 56 | python document.view(vim.current.buffer) 57 | endfunction 58 | 59 | function tex_nine#ForwardSearch() 60 | python << EOF 61 | try: 62 | document.forward_search(vim.current.buffer, vim.current) 63 | except TeXNineError, e: 64 | echoerr(e) 65 | EOF 66 | return 67 | endfunction 68 | 69 | 70 | "*********************************************************************** 71 | " Miscellaneous (Omni completion, snippets, headers, bibqueries) 72 | "*********************************************************************** 73 | 74 | function tex_nine#UpdateHeader() 75 | python document.update_header(vim.current.buffer) 76 | endfunction 77 | 78 | function tex_nine#InsertSkeleton(skeleton) 79 | python document.insert_skeleton(vim.current.buffer, vim.eval('a:skeleton')) 80 | update 81 | edit 82 | " Enter insert mode for safety and set the buffer as modified 83 | startinsert 84 | setlocal mod 85 | endfunction 86 | 87 | function tex_nine#OmniCompletion(findstart, base) 88 | if a:findstart 89 | let pos = pyeval('omni.findstart()') 90 | return pos 91 | else 92 | let compl = pyeval('omni.completions()') 93 | return compl 94 | endif 95 | endfunction 96 | 97 | function tex_nine#MathCompletion(findstart, base) 98 | if a:findstart 99 | let line = getline('.') 100 | let start = col('.') - 1 101 | while start > 0 && line[start - 1] != '\' 102 | if line[start] == ' ' | return -2 | endif 103 | let start -= 1 104 | endwhile 105 | return start 106 | else 107 | let compl = pyeval('tex_nine_maths_cache') 108 | call filter(compl, 'v:val.word =~ "^'.a:base.'"') 109 | "let res = [] 110 | "for m in compl 111 | " if m.word =~ '^'.a:base 112 | " call add(res, m) 113 | " endif 114 | "endfor 115 | return compl 116 | endif 117 | endfunction 118 | 119 | function tex_nine#Bibquery(cword) 120 | python << EOF 121 | try: 122 | document.bibquery(vim.eval('a:cword'), omni.bibpaths) 123 | except TeXNineError, e: 124 | echoerr(e) 125 | EOF 126 | return 127 | endfunction 128 | 129 | function tex_nine#IsLeft(lchar) 130 | let left = getline('.')[col('.')-2] 131 | return left == a:lchar ? 1 : 0 132 | endfunction 133 | 134 | function tex_nine#ChangeFontStyle(style) 135 | let str = 'di' 136 | let is_math = pyeval("int(is_latex_math_environment(vim.current.window))") 137 | let str .= is_math ? '\math'.a:style : '\text'.a:style 138 | let str .= "{}\\\"" 139 | return str 140 | endfunction 141 | 142 | function tex_nine#SmartInsert(keyword, ...) 143 | " Inserts a LaTeX statement and starts omni completion. If the 144 | " line already contains the statement and the statement is still 145 | " incomplete, i.e. missing the closing delimiter, only omni 146 | " completion is started. 147 | 148 | let pattern = exists('a:1') ? '\'.a:1.'{' : '\'.a:keyword 149 | let line = getline('.') 150 | let pos = col('.') 151 | 152 | " There's a beginning of a statement on the left 153 | if line[:pos] =~ pattern 154 | " Is there closing delimiter on the right and no beginning of a 155 | " new statement 156 | 157 | " The closing delimiter is closer than \ 158 | let i = pos-1 159 | while i < col('$') 160 | if line[i] == '\' 161 | break 162 | elseif line[i] == '}' 163 | return "" 164 | endif 165 | let i = i+1 166 | endwhile 167 | endif 168 | 169 | return a:keyword."}\ha" 170 | endfunction 171 | 172 | function! ListEnvCompletions(A,L,P) 173 | " Breaks if dictionary is a list but we only support one dictionary 174 | " at the moment 175 | if filereadable(&dictionary) 176 | return join(readfile(&dictionary), "\") 177 | else 178 | return [] 179 | endif 180 | endfunction 181 | 182 | function tex_nine#InsertSnippet(...) 183 | if exists('a:1') 184 | let s:envkey = a:1 185 | else 186 | let s:envkey = input('Environment: ', '', 'custom,ListEnvCompletions') 187 | endif 188 | 189 | if s:envkey != "" 190 | python snip = document.insert_snippet(vim.eval('s:envkey'), vim.eval('&ft')) 191 | return pyeval('snip') 192 | else 193 | return "\" 194 | endif 195 | endfunction 196 | 197 | function tex_nine#EnvironmentOperator(mode) 198 | let pos = pyeval('get_latex_environment(vim.current.window)["range"]') 199 | if !pos[0] && !pos[1] 200 | return "\" 201 | endif 202 | if a:mode == 'inner' 203 | let pos[0] += 1 204 | let pos[1] -= 1 205 | endif 206 | return "\:".pos[0]."\V".(pos[1] - pos[0])."jO" 207 | endfunction 208 | 209 | 210 | "*********************************************************************** 211 | " Settings 212 | "*********************************************************************** 213 | 214 | function tex_nine#AddBuffer(config, snipfile) 215 | python << EOF 216 | omni = TeXNineOmni() 217 | document = TeXNineDocument(vim.current.buffer) 218 | document.setup_snippets(vim.eval('a:snipfile'), 219 | vim.eval('&ft')) 220 | 221 | EOF 222 | if a:config.synctex == 1 223 | python << EOF 224 | try: 225 | target = document.get_master_output(vim.current.buffer) 226 | evince_proxy = tex_nine_synctex.TeXNineSyncTeX(target, logging) 227 | document.buffers[vim.current.buffer.name]['synctex'] = evince_proxy 228 | except (TeXNineError, NameError) as e: 229 | msg = 'TeX-9: Failed to connect to an Evince window: {0}'.format(str(e).decode('string_escape')) 230 | logging.debug(msg) 231 | pass 232 | EOF 233 | endif 234 | endfunction 235 | 236 | function tex_nine#SetAutoCmds(config) 237 | 238 | augroup tex_nine 239 | au BufWritePre *.tex call tex_nine#UpdateHeader() 240 | augroup END 241 | 242 | "au QuickFixCmdPre call tex_nine#Premake() 243 | "au! tex_nine QuickFixCmdPost 244 | 245 | "if a:config.verbose 246 | " au tex_nine QuickFixCmdPost call tex_nine#PostmakeVanilla() 247 | "else 248 | " au tex_nine QuickFixCmdPost call tex_nine#Postmake() 249 | "endif 250 | endfunction 251 | 252 | function tex_nine#Reconfigure(config) 253 | python << EOF 254 | try: 255 | omni.update() 256 | paths = map(path.basename, omni.bibpaths) 257 | echomsg("Updated BibTeX databases...using {0}.".format(", ".join(paths))) 258 | except TeXNineError, e: 259 | # It may be not an error. The user may not use BibTeX... 260 | echomsg("Cannot update BibTeX databases: "+str(e)) 261 | EOF 262 | 263 | silent! let tex_nine_compiler = pyeval('document.get_compiler(vim.current.buffer, update=True)') 264 | 265 | " Did it succeed? 266 | if tex_nine_compiler == "" && a:config.compiler == "" 267 | python echomsg("Cannot determine the compiler: Make sure the header contains the compiler line or compiler is set in vimrc.") 268 | return 269 | endif 270 | 271 | " Modeline takes precedence 272 | let tex_nine_compiler = tex_nine_compiler ? a:config.compiler : tex_nine_compiler 273 | 274 | if tex_nine_compiler != "" 275 | call tex_nine#ConfigureCompiler(tex_nine_compiler, a:config.synctex, a:config.shell_escape, a:config.extra_args) 276 | python echomsg("Updated the compiler...using `{}'.".format(vim.eval('tex_nine_compiler'))) 277 | else 278 | python echomsg("Cannot determine the compiler: Make sure the header contains the compiler line or compiler is set in vimrc.") 279 | endif 280 | endfunction 281 | 282 | "*********************************************************************** 283 | " Compilation 284 | "*********************************************************************** 285 | 286 | 287 | function tex_nine#Compile(deep, config) 288 | 289 | let tex_nine_compiler = tex_nine#GetCompiler(a:config) 290 | let master = tex_nine#GetMaster() 291 | 292 | if tex_nine_compiler == "" || master == "" 293 | return 294 | elseif tex_nine_compiler == "make" 295 | silent make! 296 | else 297 | update " Autowrite is not enough 298 | exe "lcd" fnameescape(fnamemodify(master, ':h')) 299 | unsilent echo "Compiling...\r" 300 | if a:deep == 1 301 | python document.compile(vim.current.buffer, vim.eval('tex_nine_compiler')) 302 | endif 303 | " Make and do not jump to the first error 304 | exe 'silent' 'make!' escape(fnamemodify(master, ':t'), ' ') 305 | lcd - 306 | endif 307 | 308 | " Post-process errors 309 | if !a:config.verbose 310 | call setqflist(pyeval('document.postmake()')) 311 | endif 312 | 313 | if (!has("gui_running")) 314 | redraw! 315 | endif 316 | 317 | let numerrors = len(filter(getqflist(), 'v:val.valid==1')) 318 | unsilent echo "Found ".numerrors." Error(s)." 319 | 320 | endfunction 321 | 322 | function tex_nine#ConfigureCompiler(compiler, synctex, shell_escape, extra_args) 323 | " Configure the l:makeprg variable according to user's preference 324 | 325 | let &l:makeprg = a:compiler 326 | if &l:makeprg != 'make' 327 | let &l:makeprg .= ' -file-line-error -interaction=nonstopmode' 328 | if a:synctex 329 | let &l:makeprg .= ' -synctex=1' 330 | endif 331 | if a:shell_escape 332 | let &l:makeprg .= ' -shell-escape' 333 | endif 334 | let &l:makeprg .= ' '.a:extra_args 335 | endif 336 | let &l:makeprg .= ' $*' 337 | 338 | " TODO: test Makefile 339 | " This is taken from vim help, see :help errorformat-LaTeX, with 340 | " addition from Srinath Avadhanula 341 | setlocal errorformat=%E!\ LaTeX\ %trror:\ %m, 342 | \%E%f:%l:\ %m, 343 | \%E!\ %m, 344 | \%+WLaTeX\ %.%#Warning:\ %.%#line\ %l%.%#, 345 | \%+W%.%#\ at\ lines\ %l--%*\\d, 346 | \%WLaTeX\ %.%#Warning:\ %m, 347 | \%Cl.%l\ %m, 348 | \%+C\ \ %m., 349 | \%+C%.%#-%.%#, 350 | \%+C%.%#[]%.%#, 351 | \%+C[]%.%#, 352 | \%+C%.%#%[{}\\]%.%#, 353 | \%+C<%.%#>%.%#, 354 | \%C\ \ %m, 355 | \%-GSee\ the\ LaTeX%m, 356 | \%-GType\ \ H\ %m, 357 | \%-G\ ...%.%#, 358 | \%-G%.%#\ (C)\ %.%#, 359 | \%-G(see\ the\ transcript%.%#), 360 | \%-G\\s%#, 361 | \%+O(%*[^()])%r, 362 | \%+O%*[^()](%*[^()])%r, 363 | \%+P(%f%r, 364 | \%+P\ %\\=(%f%r, 365 | \%+P%*[^()](%f%r, 366 | \%+P[%\\d%[^()]%#(%f%r, 367 | \%+Q)%r, 368 | \%+Q%*[^()])%r, 369 | \%+Q[%\\d%*[^()])%r 370 | 371 | endfunction 372 | -------------------------------------------------------------------------------- /doc/tex_nine.txt: -------------------------------------------------------------------------------- 1 | *tex_nine.txt* 2 | 3 | TeX-9 4 | 5 | A semi-automatic, prefix-operated 6 | LaTeX ftplugin 7 | with lots of firepower! 8 | 9 | 10 | Author: Elias Toivanen 11 | Email: See README 12 | License: GPL 13 | Version: 1.3.13 14 | 15 | TeX-9 is a ftplugin that aims to enhance the writing experience of high 16 | quality documents with LaTeX and Vim. The goal of TeX-9 is to be simple 17 | and Vimish, meaning that focus is on carefully thought-out key mappings 18 | and features that are already present in a typical Vim installation. If 19 | you need to write a thesis or research articles and insist on having 20 | only one editor for all editing tasks, then TeX-9 is for you! 21 | 22 | TeX-9 uses Python2.x as its backend and therefore a Vim installation 23 | with Python support is required. TeX-9 is being developed on Linux 24 | running Vim 7.4. 25 | 26 | The main features of TeX-9 are 27 | * Compile, debug and launch a document viewer from within Vim 28 | * Insert LaTeX code snippets with ease 29 | * Powerful text-object for LaTeX environments 30 | * Omni-completion of BibTeX database entries and label references 31 | * Omni-completion of mathematical symbols 32 | * SyncTeX support (for the Evince document viewer) 33 | * Filetype specific indentation (courtesy of Johannes Tanzler) 34 | * LaTeX2e manual (ported to Vim by Mikolaj Machowski) 35 | * No-hassle settings, relatively few mappings 36 | 37 | Shoutouts & thanks 38 | * Carl Mueller, this ftplugin was inspired by his `auctex.vim' script 39 | * Vim-LaTeX people Srinath Avadhanula, Mikolaj Machowski and Benji Fisher 40 | * Johannes Tanzler, Jose Aliste, Sergio Losilla 41 | * Peter Lewis, Volker Lorrmann 42 | 43 | ============================================================================== 44 | 45 | *TeX-9* *tex_nine* 46 | 47 | 1. Installation |tex_nine-installation|| 48 | 2. Basics |tex_nine-basics| 49 | 3. Advanced |tex_nine-advanced| 50 | 4. Snippets |tex_nine-snippets| 51 | 5. BibTeX |tex_nine-bibtex| 52 | 6. Mappings |tex_nine-mappings| 53 | 7. Tips and trick |tex_nine-tips| 54 | 55 | ============================================================================== 56 | 57 | 1. Installation *tex_nine-installation* 58 | 59 | TeX-9 is distributed as a gzipped tarball. Unzip it to your local 60 | runtime path, usually `~/.vim/'. 61 | 62 | Next, open up |vimrc| and ensure it contains the following lines 63 | > 64 | filetype plugin indent on 65 | let g:tex_flavor = 'latex' 66 | < 67 | For basic usage you don't need to configure anything else. However, 68 | you may tweak some features of TeX-9 by defining a |Dictionary| called 69 | `g:tex_nine_config' in your vimrc. The following keys are recognized: 70 | 71 | compiler: String 72 | * The TeX compiler you want to use (xelatex, pdflatex, latex, make...) 73 | * Recommended setting 74 | * See |tex_nine-advanced| for details. 75 | * Default: undefined 76 | 77 | leader: String 78 | * Most TeX-9 mappings begin with this prefix 79 | * Optional 80 | * Default: The values of |mapleader| and |maplocalleader| are 81 | honored. Otherwise set to semi-colon ';'. 82 | 83 | viewer: Dictionary 84 | * Application used for viewing documents. 85 | * Vim dictionary with keys 'app' and 'target'. 86 | * Optional 87 | * Default: {'app': 'xdg-open', 'target': 'pdf'} 88 | 89 | verbose: Boolean 90 | * Controls the amount of output in error logs 91 | * Error messages are gathered in a ||quickfix|| list that 92 | you may access by typing Q in normal mode. 93 | * Optional 94 | * Default: 0 (Less verbose logs) 95 | 96 | synctex: Boolean 97 | * Highlight current source code position in a PDF viewer and vice 98 | versa. 99 | * GVim/Evince only. 100 | * See |tex_nine-advanced| for details 101 | * Optional 102 | * Default: 0 (Disabled) 103 | 104 | shell_escape: Boolean 105 | * The LaTeX compiler will be called with the -shell-escape flag. 106 | * Required for packages such as minted, etc. 107 | * Optional 108 | * Default: 0 (Disabled) 109 | 110 | extra_args: String 111 | * Whatever extra arguments you want to give the LaTeX compiler. 112 | * For the -shell-escape flag, see above. 113 | * Optional 114 | * Default: "" 115 | 116 | disable: Boolean 117 | * TeX-9 is disabled temporarily. 118 | * Default: 0 (TeX-9 is loaded) 119 | 120 | Examples: > 121 | 122 | " Old school LaTeX user 123 | let g:tex_nine_config = { 124 | \'compiler': 'latex', 125 | \'viewer': {'app':'xdvi', 'target':'dvi'}, 126 | \} 127 | 128 | " A MacVim user 129 | let g:tex_nine_config = { 130 | \'compiler': 'pdflatex', 131 | \'viewer': {'app':'open', 'target':'pdf'}, 132 | \} 133 | 134 | " Xelatex user who wants SyncTeX support 135 | let g:tex_nine_config = { 136 | \'compiler': 'xelatex', 137 | \'synctex': 1 138 | \} 139 | 140 | " Makefile users 141 | let g:tex_nine_config = { 142 | \'compiler': 'make', 143 | \'verbose': 1 144 | \} 145 | < 146 | 147 | ============================================================================== 148 | 149 | 2. Basics *tex_nine-basics* 150 | 151 | TeX-9 defines various mappings that speed up typesetting LaTeX code. Most 152 | of the mappings are prefixed with a leader referred below with the symbol 153 | . If you have set `g:tex_nine_config.leader', 154 | |maplocalleader| or |mapleader|, the corresponding character is used. 155 | Otherwise, the leader defaults to semi-colon. 156 | 157 | Below is a short tutorial that should get you going in no time. Users who 158 | want to use SyncTeX, split their LaTeX manuscripts in several files and/or 159 | use different kinds of LaTeX compilers at the same time should also read 160 | the |tex_nine-advanced| section. 161 | 162 | 2.1. Templates 163 | 164 | The buttons , and insert skeleton files for the article 165 | documentclass with the preamble adjusted for xelatex, pdflatex and 166 | latex respectively. Press to insert a barebone template that is 167 | intended for Makefile users. Edit the files in the `skeleton' folder 168 | to customize the templates to your taste. 169 | 170 | 2.2. Insert mode 171 | 172 | Type M to get a popup list of different maths symbols. In 173 | addition, the most frequently used maths symbols have their own 174 | shortcuts. Typing a expands to \alpha for example. Refer 175 | to |tex_nine-mappings| for a complete listing. 176 | 177 | Type C to insert a citation, i.e. `\cite{citekey}'. You're 178 | prompted with a popup list of completions if the \bibliography{} statement 179 | contains a valid BibTeX file (see |tex_nine-bibtex| for details). Inserting 180 | references, `\ref{ref}', works in a similar way. The corresponding mapping is 181 | R. 182 | 183 | To insert an environment, press B. You're prompted for an 184 | environment name and if a corresponding LaTeX code snippet was defined, 185 | it is inserted into the file (see |tex_nine-snippets|). 186 | 187 | 2.3. Normal mode 188 | 189 | The mapping k, `small compile', compiles your document 190 | once and doesn't bother about references; K, `big 191 | compile', calls additionally bibtex and should get the cross-references 192 | right. You're informed about potential errors. To go over them, open 193 | the ||quickfix|| list with Q. Typing V should 194 | open the document in your desktop's default PDF viewer, if you didn't 195 | set `g:tex_nine_config.viewer' to something else. 196 | 197 | Should you need advice on LaTeX, consult the LaTeX2e manual with `:help 198 | latex'. 199 | 200 | 201 | ============================================================================== 202 | 203 | 3. Advanced *tex_nine-advanced* 204 | 205 | 3.1 Automatic compiler detection/Changing compiler on-the-fly 206 | 207 | Some users need to switch between different LaTeX compilers. For this 208 | reason TeX-9 allows you to leave the setting `g:tex_nine_config.compiler' 209 | undefined and let TeX-9 determine the compiler on a file-by-file basis 210 | from a modeline of the form 211 | > 212 | % Compiler: COMPILER 213 | < 214 | where COMPILER could for example be `pdflatex'. The modeline should appear 215 | in the ten first lines of the (main) LaTeX file. If you change the line 216 | containing COMPILER, remember to make the changes effective by pressing 217 | U in normal mode. 218 | 219 | A recipe for changing the compiler on the fly would be 220 | 221 | 1. Yank the entire document environment (see Extras in |tex_nine-mappings|) 222 | 2. Change template (, , , ) 223 | 3. Paste the yanked text back in the buffer 224 | 4. Update changes (U) 225 | 226 | NB! If you are only using one compiler all the time, it is recommended to 227 | set `g:tex_nine_config.compiler' in |vimrc|. This way you can compile even 228 | your old LaTeX files without problems. 229 | 230 | 3.2. Multi-file projects 231 | 232 | The traditional way to handle multi-file projects is to set up a Makefile 233 | and compile with `make'. TeX-9 supports this behavior via the 234 | `g:tex_nine_config.compiler' option which can be set to `make'. 235 | 236 | You can save yourself the trouble of writing a Makefile by indicating the 237 | relative location of the main file in the \include-ed files with a modeline 238 | of the form 239 | > 240 | % mainfile: MASTER_FILE 241 | < 242 | The string MASTER_FILE could be for example `../main.tex' if the included file 243 | is in a subdirectory of the actual compilation folder. The modeline may appear 244 | in the three first or three last lines of the document. This way all the 245 | TeX-9 mappings continue to work as expected wherever you are in your 246 | project. 247 | 248 | NB! Make sure the filename MASTER_FILE does not contain any whitespace and 249 | have the main file to be active in Vim (see |active-buffers|). Otherwise 250 | TeX-9 cannot access its contents which is required for some features. 251 | 252 | 3.3 SyncTeX *tex_nine-synctex* 253 | 254 | If you have set `g:tex_nine_config.synctex' and use Evince 255 | (http://projects.gnome.org/evince), you can Ctrl-click a line in Evince 256 | and see the corresponding line highlighted in GVim! This is called 257 | forward searching. Backward searching works similarly: you select a 258 | cursor position in GVim and click on the position. The 259 | correct line should then be highlighted in Evince. SyncTeXing from 260 | included files works too, but remember to set the modeline to the 261 | correct main file (see above). 262 | 263 | The requirements for SyncTeX support are: dbus-python and a Vim 264 | installation _without_ a python3 interpreter. The feature is known to 265 | work correctly with Evince 3.8.3 and TeXLive 2013. 266 | 267 | ============================================================================== 268 | 269 | 4. Snippets *tex_nine-snippets* 270 | 271 | When you want to insert a LaTeX snippet with B, 272 | notice that the input prompt is -completable. Your input is 273 | matched against words in `tex_dictionary.txt'. Once entered, the 274 | name of the environment is matched against keywords in the file 275 | `snippets/tex_snippets.snippets'. Matching snippets are inserted. 276 | Otherwise TeX-9 inserts a generic environment in LaTeX manuscripts 277 | and raises an error in BibTeX files. 278 | > 279 | % Generic environment 280 | \begin{keyword} 281 | 282 | \end{keyword} 283 | < 284 | You may extend the snippet file with your own environments and you will 285 | notice that the syntax bears resemblance with Michael Sander's snipMate 286 | plugin (http://www.vim.org/scripts/script.php?script_id=2540). TeX-9 287 | leaves the key untouched so that you may still resort to snipMate 288 | if you so prefer. If your custom environments is not included in 289 | `tex_dictionary.txt', append it there. > 290 | 291 | :cd ~/.vim/ftplugin/TeX_9/dictionaries 292 | :!echo 'new_environment' >> tex_dictionary.txt 293 | < 294 | ============================================================================== 295 | 296 | 5. BibTeX *tex_nine-bibtex* 297 | 298 | When adding entries in BibTeX databases or appending new databases in the 299 | \bibliography{} statement, you need tell TeX-9 to update its citekey 300 | database. This is accomplished by typing U in normal mode. 301 | 302 | In addition to citekey completion, TeX-9 provides a preview feature 303 | that makes it easier to work with BibTeX and LaTeX files in the same 304 | Vim session. You may take a quick peek at a particular BibTeX entry 305 | by pressing `gb' over its citekey, i.e. \cite{citekey}. This command 306 | is in line with ||gd|| and |gf| with the exception that the BibTeX 307 | entry is shown in a |preview-window||. 308 | 309 | 310 | ============================================================================== 311 | 312 | 6. Mappings *tex_nine-mappings* 313 | 314 | The symbol refers to the value of 315 | `g:tex_nine_config.leader', |maplocalleader|, |mapleader|. If none of 316 | these are set, the default value is semi-colon ';'. 317 | 318 | 6.1 Insert mode > 319 | 320 | 321 | K Dictionary completion 322 | M Maths completion 323 | C Insert a citation 324 | B Insert an environment 325 | R Insert a reference 326 | E Insert an equation reference 327 | < 328 | Greek 329 | > 330 | a \alpha 331 | b \beta 332 | c \chi 333 | d \delta 334 | e \epsilon 335 | f \phi 336 | g \gamma 337 | h \eta 338 | k \kappa 339 | l \lambda 340 | m \mu 341 | n \nu 342 | o \omega 343 | p \pi 344 | q \theta 345 | r \varrho 346 | s \sigma 347 | t \tau 348 | u \upsilon 349 | w \varpi 350 | x \xi 351 | y \psi 352 | z \zeta 353 | D \Delta 354 | F \Phi 355 | G \Gamma 356 | L \Lambda 357 | O \Omega 358 | P \Pi 359 | Q \Theta 360 | U \Upsilon 361 | X \Xi 362 | Y \Psi 363 | < 364 | Maths 365 | > 366 | N \nabla 367 | S \sum_{}^{} 368 | I \int\limits_{}^{} 369 | V \vec{} 370 | 0 \emptyset 371 | 6 \partial 372 | i \infty 373 | / \frac{}{} 374 | v \vee 375 | & \wedge 376 | @ \circ 377 | \ \setminus 378 | = \equiv 379 | * \cdot 380 | - \bigcap 381 | + \bigcup 382 | < \leq 383 | > \geq 384 | ~ \tilde{} 385 | ^ \hat{} 386 | _ \bar{} 387 | ( \left(\right) 388 | [ \left[\right] 389 | { \left{\right} 390 | \nonumber\\ 391 | < 392 | 393 | 6.2 Normal Mode > 394 | 395 | to Insert template files 396 | Jump to next section or chapter 397 | Jump to previous section or chapter 398 | gd Goto label's declaration 399 | gb Goto citekey's declaration 400 | k Small compile 401 | K Big compile 402 | V View the document 403 | SyncTeX: Forward search 404 | Q View the quickfix window 405 | U Reconfigure TeX-9 406 | 407 | 6.4 Extras 408 | 409 | TeX-9 comes with a custom `environment operator' (see ||text-objects||). 410 | Press 'vie' or 'vae' in normal normal to highlight the current inner 411 | environment (without the \begin and \end statements) or the outer 412 | environment respectively. Replace 'v' with another operator to achieve 413 | yanking, changing or deleting etc. For example, typing 'dae' makes it 414 | trivial to move figures and tables around in the document. Delete the 415 | environment, find a new location and paste it back to the buffer! 416 | 417 | There are also some macros that work by tapping a character on your 418 | keyboard (super convenient for subscripts and superscripts!). 419 | 420 | > 421 | ^^ -> ^{} 422 | __ -> _{} 423 | ~~ -> \approx 424 | == -> &= 425 | < 426 | Finally, try omni-completion () inside curly braces when you're 427 | including a picture with `\includegraphics{}' or when you're setting your 428 | font with the `fontspec' package, e.g. `\setmainfont{}'. You'll get a 429 | listing of pictures in the compilation folder in the first case and a list 430 | of installed font on your system in the latter. Supported picture formats 431 | are EPS, PDF, JPG and PNG. 432 | 433 | ============================================================================== 434 | 435 | 7. Tips and trick *tex_nine-tips* 436 | 437 | 7.1. Preferred way to override, extend and hack TeX-9 438 | 439 | Create a custom tex.vim file in the after directory, i.e. 440 | ~/.vim/after/ftplugin/tex.vim. Here you can redefine mappings and 441 | extend TeX-9's functionality with your own ideas. If you come up with 442 | something sweet, drop me a line (email address available on Vim.org 443 | and in the README). 444 | 445 | 7.2 Spell checking 446 | 447 | If you've enabled 'modeline', you may conveniently activate spell 448 | checking in your LaTeX documents by editing the modeline in the 449 | skeleton file. 450 | 451 | Example for anglophones: > 452 | 453 | % vim:tw=66 sw=2 ft=tex spell spelllang=en 454 | < 455 | Notice that newer versions of Vim provide an option > 456 | 457 | let g:tex_comment_nospell= 1 458 | 459 | < for disabling spell checking of comments that otherwise get messed up 460 | pretty badly. 461 | 462 | 7.3 Folding 463 | 464 | With newer versions of Vim it's easy as > 465 | 466 | let g:tex_fold_enabled = 1 467 | 468 | 7.4 SyncTeXing without Evince 469 | 470 | It might be possible to get SyncTeX working with some other PDF viewers, but 471 | you'd need the write wrapper scripts by yourself. However, there's one TeX-9 472 | function that you might find useful. If you want to know the absolute name of 473 | the PDF file in your project, you can use the function 474 | `tex_nine#GetOutputFile()'. 475 | 476 | To avoid conflicts with Evince, please leave 477 | `g:tex_nine_config.synctex' unset and ensure you have 478 | > 479 | \synctex=1 480 | < 481 | in your preamble. 482 | 483 | 7.5. Custom templates 484 | 485 | I like to include some extra packages in the preamble. Here's what I 486 | have in my ~/.vim/after/ftplugin/tex.vim 487 | 488 | > 489 | let custom_template = expand('$HOME').'/.vim/after/ftplugin/tex_skeleton.tex.custom' 490 | noremap :call tex_nine#InsertSkeleton(custom_template) 491 | < 492 | 493 | 7.6 Change the typeface of a word, sentence... 494 | 495 | If you are not using Tim Pope's famous `surround.vim' plugin and would 496 | like to have neat way of changing the typeface of text, you can add 497 | these mappings to ~/.vim/after/ftplugin/tex.vim. 498 | 499 | > 500 | vmap bf tex_nine#ChangeFontStyle('bf') 501 | vmap it tex_nine#ChangeFontStyle('it') 502 | vmap rm tex_nine#ChangeFontStyle('rm') 503 | vmap sf tex_nine#ChangeFontStyle('sf') 504 | vmap tt tex_nine#ChangeFontStyle('tt') 505 | vmap up di\text{}" 506 | < 507 | For example, to convert the word under the cursor to boldface, type 508 | > 509 | viwbf 510 | < 511 | 512 | ============================================================================== 513 | 514 | 515 | vim:tw=72:ts=8:ft=help:norl:autoindent 516 | 517 | 518 | -------------------------------------------------------------------------------- /ftplugin/bib_nine.vim: -------------------------------------------------------------------------------- 1 | " LaTeX filetype plugin 2 | " Languages: BibTeX 3 | " Maintainer: Elias Toivanen 4 | " Version: 1.3.13 5 | " Last Change: 6 | " License: GPL 7 | 8 | "************************************************************************ 9 | " 10 | " TeX-9 library: Python module 11 | " 12 | " This program is free software: you can redistribute it and/or modify 13 | " it under the terms of the GNU General Public License as published by 14 | " the Free Software Foundation, either version 3 of the License, or 15 | " (at your option) any later version. 16 | " 17 | " This program is distributed in the hope that it will be useful, 18 | " but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | " MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | " GNU General Public License for more details. 21 | " 22 | " You should have received a copy of the GNU General Public License 23 | " along with this program. If not, see . 24 | " 25 | " Copyright Elias Toivanen, 2011-2014 26 | " 27 | " 28 | "************************************************************************ 29 | 30 | if !has('python') 31 | echoerr "TeX-9: a Vim installation with +python is required" 32 | finish 33 | endif 34 | 35 | " Let the user have the last word 36 | if exists('g:tex_nine_config') && has_key(g:tex_nine_config, 'disable') 37 | if g:tex_nine_config.disable 38 | redraw 39 | echomsg("TeX-9: Disabled by user.") 40 | finish 41 | endif 42 | endif 43 | 44 | " Load Vimscript only once per buffer 45 | if exists('b:init_tex_nine') 46 | finish 47 | endif 48 | let b:init_tex_nine = 1 49 | 50 | "*********************************************************************** 51 | ru ftplugin/tex_nine/tex_nine_common.vim 52 | call tex_nine#AddBuffer(b:tex_nine_config, b:bib_nine_snippets) 53 | 54 | "*********************************************************************** 55 | 56 | " Save old leader 57 | if exists('g:maplocalleader') 58 | let s:maplocalleader_saved = g:maplocalleader 59 | endif 60 | let g:maplocalleader = b:tex_nine_config.leader 61 | 62 | inoremap B tex_nine#InsertSnippet() 63 | 64 | " Greek 65 | inoremap a \alpha 66 | inoremap b \beta 67 | inoremap c \chi 68 | inoremap d \delta 69 | inoremap e \epsilon 70 | inoremap f \phi 71 | inoremap g \gamma 72 | inoremap h \eta 73 | inoremap k \kappa 74 | inoremap l \lambda 75 | inoremap m \mu 76 | inoremap n \nu 77 | inoremap o \omega 78 | inoremap p \pi 79 | inoremap q \theta 80 | inoremap r \rho 81 | inoremap s \sigma 82 | inoremap t \tau 83 | inoremap u \upsilon 84 | inoremap w \varpi 85 | inoremap x \xi 86 | inoremap y \psi 87 | inoremap z \zeta 88 | inoremap D \Delta 89 | inoremap F \Phi 90 | inoremap G \Gamma 91 | inoremap L \Lambda 92 | inoremap O \Omega 93 | inoremap P \Pi 94 | inoremap Q \Theta 95 | inoremap U \Upsilon 96 | inoremap X \Xi 97 | inoremap Y \Psi 98 | 99 | " Math 100 | inoremap ½ \sqrt{} 101 | inoremap N \nabla 102 | inoremap S \sum_{}^{}F}i 103 | inoremap I \int\limits_{}^{}F}i 104 | inoremap 0 \emptyset 105 | inoremap 6 \partial 106 | inoremap i \infty 107 | inoremap / \frac{}{}F}i 108 | inoremap v \vee 109 | inoremap & \wedge 110 | inoremap @ \circ 111 | inoremap \ \setminus 112 | inoremap = \equiv 113 | inoremap - \bigcap 114 | inoremap + \bigcup 115 | inoremap < \leq 116 | inoremap > \geq 117 | inoremap ~ \tilde{} 118 | inoremap ^ \hat{} 119 | inoremap _ \bar{} 120 | inoremap . \dot{} 121 | inoremap \nonumber\\ 122 | 123 | " Enlarged delimiters 124 | inoremap ( \left(\right)F(a 125 | inoremap [ \left[\right]F[a 126 | inoremap { \left\{ \right\}F a 127 | 128 | " Neat insertion of various LaTeX constructs by tapping keys 129 | inoremap _ tex_nine#IsLeft('_') ? '{}' : '_' 130 | inoremap ^ tex_nine#IsLeft('^') ? '{}' : '^' 131 | inoremap = tex_nine#IsLeft('=') ? '&=' : '=' 132 | inoremap ~ tex_nine#IsLeft('~') ? '\approx' : '~' 133 | "inoremap < tex_nine#IsLeft('<') ? '\ll' : '<' 134 | "inoremap > tex_nine#IsLeft('>') ? '\gg' : '>' 135 | 136 | if exists('s:maplocalleader_saved') 137 | let g:maplocalleader = s:maplocalleader_saved 138 | else 139 | unlet g:maplocalleader 140 | endif 141 | -------------------------------------------------------------------------------- /ftplugin/tex_nine.vim: -------------------------------------------------------------------------------- 1 | " LaTeX filetype plugin 2 | " Languages: LaTeX 3 | " Maintainer: Elias Toivanen 4 | " Version: 1.3.13 5 | " Last Change: 6 | " License: GPL 7 | 8 | "************************************************************************ 9 | " 10 | " TeX-9 library: Vim script 11 | " 12 | " This program is free software: you can redistribute it and/or modify 13 | " it under the terms of the GNU General Public License as published by 14 | " the Free Software Foundation, either version 3 of the License, or 15 | " (at your option) any later version. 16 | " 17 | " This program is distributed in the hope that it will be useful, 18 | " but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | " MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 20 | " GNU General Public License for more details. 21 | " 22 | " You should have received a copy of the GNU General Public License 23 | " along with this program. If not, see . 24 | " 25 | " Copyright Elias Toivanen, 2011-2014 26 | " 27 | " 28 | "************************************************************************ 29 | 30 | if !has('python') 31 | echoerr "TeX-9: a Vim installation with +python is required" 32 | finish 33 | endif 34 | 35 | " Let the user have the last word 36 | if exists('g:tex_nine_config') && has_key(g:tex_nine_config, 'disable') 37 | if g:tex_nine_config.disable 38 | redraw 39 | echomsg("TeX-9: Disabled by user.") 40 | finish 41 | endif 42 | endif 43 | 44 | " Load Vimscript only once per buffer 45 | if exists('b:init_tex_nine') 46 | finish 47 | endif 48 | let b:init_tex_nine = 1 49 | 50 | "*********************************************************************** 51 | ru ftplugin/tex_nine/tex_nine_common.vim 52 | 53 | setlocal completeopt=longest,menuone 54 | setlocal fo=tcq 55 | setlocal tw=72 sw=2 56 | setlocal tabstop=8 57 | setlocal omnifunc=tex_nine#OmniCompletion 58 | setlocal completefunc=tex_nine#MathCompletion 59 | 60 | call tex_nine#AddBuffer(b:tex_nine_config, b:tex_nine_snippets) 61 | call tex_nine#SetAutoCmds(b:tex_nine_config) 62 | 63 | "*********************************************************************** 64 | 65 | " Mappings 66 | 67 | " Leader 68 | 69 | " Save old leader 70 | if exists('g:maplocalleader') 71 | let s:maplocalleader_saved = g:maplocalleader 72 | endif 73 | 74 | let g:maplocalleader = b:tex_nine_config.leader 75 | 76 | " Templates 77 | noremap :call tex_nine#InsertSkeleton(b:tex_nine_skeleton.'.xelatex') 78 | noremap :call tex_nine#InsertSkeleton(b:tex_nine_skeleton.'.pdflatex') 79 | noremap :call tex_nine#InsertSkeleton(b:tex_nine_skeleton.'.latex') 80 | noremap :call tex_nine#InsertSkeleton(b:tex_nine_skeleton.'.make') 81 | 82 | " Viewing 83 | noremap V :call tex_nine#ViewDocument() 84 | 85 | " Compilation 86 | noremap k :call tex_nine#Compile(0, b:tex_nine_config) 87 | noremap K :call tex_nine#Compile(1, b:tex_nine_config) 88 | 89 | " Misc 90 | noremap U :call tex_nine#Reconfigure(b:tex_nine_config) 91 | noremap Q :copen 92 | noremap gd yiB/\\label{0} 93 | noremap gb :call tex_nine#Bibquery(expand('')) 94 | 95 | " Insert mode mappings 96 | inoremap 97 | inoremap K  98 | inoremap M \ 99 | inoremap B tex_nine#InsertSnippet() 100 | imap E tex_nine#SmartInsert('\eqref{') 101 | imap R tex_nine#SmartInsert('\ref{') 102 | imap C tex_nine#SmartInsert('\cite{', '\[cC]ite') 103 | 104 | " SyncTeX 105 | if b:tex_nine_config.synctex 106 | noremap :call tex_nine#ForwardSearch() 107 | endif 108 | 109 | " Greek 110 | inoremap a \alpha 111 | inoremap b \beta 112 | inoremap c \chi 113 | inoremap d \delta 114 | inoremap e \epsilon 115 | inoremap f \phi 116 | inoremap g \gamma 117 | inoremap h \eta 118 | inoremap k \kappa 119 | inoremap l \lambda 120 | inoremap m \mu 121 | inoremap n \nu 122 | inoremap o \omega 123 | inoremap p \pi 124 | inoremap q \theta 125 | inoremap r \rho 126 | inoremap s \sigma 127 | inoremap t \tau 128 | inoremap u \upsilon 129 | inoremap w \varpi 130 | inoremap x \xi 131 | inoremap y \psi 132 | inoremap z \zeta 133 | inoremap D \Delta 134 | inoremap F \Phi 135 | inoremap G \Gamma 136 | inoremap L \Lambda 137 | inoremap O \Omega 138 | inoremap P \Pi 139 | inoremap Q \Theta 140 | inoremap U \Upsilon 141 | inoremap X \Xi 142 | inoremap Y \Psi 143 | 144 | " Math 145 | 146 | " Start mathmode completion 147 | inoremap \ \setminus 148 | inoremap ½ \sqrt{} 149 | inoremap N \nabla 150 | inoremap S \sum_{}^{}F}i 151 | inoremap V \vec{} 152 | inoremap I \int\limits_{}^{}F}i 153 | inoremap 0 \emptyset 154 | inoremap 6 \partial 155 | inoremap i \infty 156 | inoremap / \frac{}{}F}i 157 | inoremap v \vee 158 | inoremap & \wedge 159 | inoremap @ \circ 160 | inoremap * \cdot 161 | inoremap = \equiv 162 | inoremap - \bigcap 163 | inoremap + \bigcup 164 | inoremap < \leq 165 | inoremap > \geq 166 | inoremap ~ \tilde{} 167 | inoremap ^ \hat{} 168 | inoremap _ \bar{} 169 | inoremap . \dot{} 170 | inoremap \nonumber\\ 171 | 172 | " Enlarged delimiters 173 | inoremap ( \left(\right)F(a 174 | inoremap [ \left[\right]F[a 175 | inoremap { \left\{ \right\}F a 176 | 177 | " Neat insertion of various LaTeX constructs by tapping keys 178 | inoremap _ tex_nine#IsLeft('_') ? '{}' : '_' 179 | inoremap ^ tex_nine#IsLeft('^') ? '{}' : '^' 180 | inoremap = tex_nine#IsLeft('=') ? '&=' : '=' 181 | inoremap ~ tex_nine#IsLeft('~') ? '\approx' : '~' 182 | 183 | " These are problematic when you want to type << or >> (C bitshift, C++ operators) 184 | "inoremap < tex_nine#IsLeft('<') ? '\ll' : '<' 185 | "inoremap > tex_nine#IsLeft('>') ? '\gg' : '>' 186 | 187 | " Robust inner/outer environment operators 188 | vmap ae tex_nine#EnvironmentOperator('outer') 189 | omap ae :normal vae 190 | vmap ie tex_nine#EnvironmentOperator('inner') 191 | omap ie :normal vie 192 | 193 | if exists('s:maplocalleader_saved') 194 | let g:maplocalleader = s:maplocalleader_saved 195 | else 196 | unlet g:maplocalleader 197 | endif 198 | -------------------------------------------------------------------------------- /ftplugin/tex_nine/__init__.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | #************************************************************************ 3 | # 4 | # TeX-9 library: Python module 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see . 18 | # 19 | # Copyright Elias Toivanen, 2011-2014 20 | # 21 | #************************************************************************ 22 | 23 | # Short summary of the module: 24 | # 25 | # Defines two main objects TeXNineDocument and TeXNineOmni that are 26 | # meant to handle editing and completion tasks. Both of these classes 27 | # are singletons. 28 | 29 | # System modules 30 | import vim 31 | import sys 32 | import re 33 | import subprocess 34 | import os 35 | import os.path as path 36 | import logging 37 | 38 | from getpass import getuser 39 | from time import strftime 40 | from itertools import groupby 41 | from string import Template 42 | 43 | #Local modules 44 | # config = vim.bindeval('b:tex_nine_config') 45 | # TODO: Remove vim.eval() in favor of vim.bindeval() 46 | # TODO: Separate python module from b:tex_nine_config 47 | # Older Vim's do not have bindeval 48 | config = vim.eval('b:tex_nine_config') 49 | config['disable'] = int(config['disable']) 50 | config['debug'] = int(config['debug']) 51 | config['synctex'] = int(config['synctex']) 52 | config['verbose'] = int(config['verbose']) 53 | 54 | sys.path.extend([config['_pypath']]) 55 | from tex_nine_symbols import tex_nine_maths_cache 56 | from tex_nine_utils import * 57 | 58 | # Control debugging 59 | if config['debug']: 60 | logging.basicConfig(level=logging.DEBUG, stream=sys.stdout) 61 | else: 62 | logging.basicConfig(level=logging.ERROR) 63 | 64 | # Control SyncTeX 65 | # TODO: Python 3 support 66 | if config['synctex']: 67 | if int(vim.eval("has('gui_running')")): 68 | if not int(vim.eval("has('python3')")): 69 | logging.debug("TeX-9: Importing tex_nine_synctex") 70 | # NB: Important side effect: Vim will be hooked to the DBus session daemon 71 | import tex_nine_synctex 72 | else: 73 | echoerr("Must not have +python3 when using SyncTeX.") 74 | else: 75 | echomsg("SyncTeX not available in terminal.") 76 | 77 | # Miscellaneous extra settings 78 | config['_datelabel'] = '% Last Change:' 79 | config['_timestr'] = '%Y %b %d' 80 | 81 | # Start of the main module 82 | logging.debug("TeX-9: Entering the Python module.") 83 | 84 | messages = { 85 | 'NO_BIBTEX': 'No BibTeX databases present...', 86 | 'INVALID_BIBFILE': 'Invalid BibTeX file: `{0}\'', 87 | 'INVALID_BIBENTRY_TYPE': 'No such BibTeX entry type: `{0}\'', 88 | 'INVALID_BIBENTRY': 'Following BibTeX entry is invalid: {0}', 89 | 'INVALID_MODELINE': 'Cannot find master file `{0}\'', 90 | 'NO_MODELINE': 'Cannot find master file: no modeline or \documentclass statement', 91 | 'MASTER_NOT_ACTIVE': 'Please have the master file `{0}\' open in Vim.', 92 | 'NO_OUTPUT': 'Output file `{0}\' does not exist.', 93 | 'INVALID_HEADER': r'Missing information in header.', 94 | 'NO_BIBSTYLE': r'No valid bibliography style found in the document.', 95 | 'NO_COMPILER': r'Compiler unknown.' 96 | } 97 | 98 | class TeXNineBase(object): 99 | """Singleton base class for TeX-9.""" 100 | 101 | _instance = None 102 | buffers = {} 103 | 104 | def __new__(self, *args, **kwargs): 105 | if self._instance is None: 106 | self._instance = object.__new__(self) 107 | return self._instance 108 | 109 | def add_buffer(self, vimbuffer): 110 | """Add vimbuffer to buffers. 111 | 112 | Does not override existing entries. 113 | """ 114 | logging.debug("TeX-9: Adding `{0}\' to buffer dict.".format(vimbuffer.name)) 115 | bufinfo = { 116 | 'ft' : vim.eval('&ft'), 117 | 'master': "", 118 | 'buffer': vimbuffer, 119 | 'synctex': None 120 | } 121 | 122 | self.buffers.setdefault(vimbuffer.name, bufinfo) 123 | return 124 | 125 | def find_master_file(self, vimbuffer, nlines=3): 126 | """Finds the filename of the master file in a LaTeX project. 127 | 128 | Checks if `vimbuffer' contains a \documentclass statement and sets 129 | the master file to `vimbuffer.name'. Otherwise checks the 130 | `nlines' first and `nlines' last lines for modeline of the form 131 | 132 | % mainfile: 133 | 134 | where is the path of the master file relative to 135 | the master file, e.g. ../main.tex. 136 | 137 | Raises `TeXNineError' if master cannot be found. 138 | 139 | """ 140 | 141 | # Most often this is the case 142 | for line in vimbuffer: 143 | if '\\documentclass' in line: 144 | return vimbuffer.name 145 | 146 | # Look for modeline 147 | for line in vimbuffer[:nlines]+vimbuffer[-nlines:]: 148 | match = re.search(r'^\s*%\s*mainfile:\s*(\S+)', line) 149 | if match: 150 | master_file = path.join(path.dirname(vimbuffer.name), 151 | match.group(1)) 152 | master_file = path.abspath(master_file) 153 | 154 | if path.exists(master_file): 155 | return master_file 156 | else: 157 | e = messages['INVALID_MODELINE'].format(match.group(1)) 158 | raise TeXNineError(e) 159 | 160 | # Empty buffer, no match or no read access to master 161 | raise TeXNineError(messages['NO_MODELINE']) 162 | 163 | def get_master_file(self, vimbuffer): 164 | """Returns the filename of the master file.""" 165 | 166 | if not self.buffers[vimbuffer.name]['master']: 167 | master = self.find_master_file(vimbuffer) 168 | self.buffers[vimbuffer.name]['master'] = master 169 | 170 | # Make sure master knows it's the master 171 | masterinfo = self.buffers.get(master) 172 | if masterinfo is not None: 173 | masterinfo['master'] = master 174 | 175 | return self.buffers[vimbuffer.name]['master'] 176 | 177 | @staticmethod 178 | def multi_file(f): 179 | """Decorates methods that need to know the actual master file in 180 | a multi-file project. 181 | 182 | The decorator swaps passed vim.buffer object to the vim.buffer object 183 | of the master file. 184 | 185 | When calling a decorated method, `TeXNineError' has to be caught. 186 | 187 | """ 188 | def new_f(self, vimbuffer, *args, **kwargs): 189 | 190 | master = self.get_master_file(vimbuffer) 191 | masterbuffer = self.buffers.get(master) 192 | if masterbuffer is None: 193 | # Master is not loaded yet 194 | # NB: badd does not make the master buffer active so 195 | # decorated methods are not guaranteed to get read access to 196 | # the master buffer. 197 | vim.command('badd {0}'.format(master.replace(' ', '\ '))) 198 | for b in vim.buffers: 199 | if b.name == master: 200 | break 201 | self.add_buffer(b) 202 | self.buffers[master]['master'] = master 203 | masterbuffer = self.buffers[master] 204 | 205 | return f(self, masterbuffer['buffer'], *args, **kwargs) 206 | 207 | return new_f 208 | 209 | class TeXNineBibTeX(TeXNineBase): 210 | """A class to gather BibTeX entries in a list. 211 | 212 | After instantiation, this object tries to figure out 213 | all BibTeX files in a project by looking at the master file 214 | containing the \\bibliography{...} statement. 215 | 216 | Alternatively, this behavior may be overridden by providing 217 | a list of absolute paths to the BibTeX files: 218 | 219 | # Let the object figure out everything 220 | omni = TeXNineBibTeX() 221 | entries = omni.bibentries 222 | 223 | # DIY 224 | omni = TeXNineBibTeX() 225 | omni.bibpaths = [path1, path2,...] 226 | entries = omni.bibentries 227 | 228 | # Update entries 229 | omni.update() #or omni.update(my_new_paths) 230 | 231 | """ 232 | 233 | _bibcompletions = [] 234 | _bibpaths = set([]) 235 | 236 | def _bibparser(self, fname): 237 | """Opens a file and extracts all BibTeX entries in it.""" 238 | try: 239 | with open(fname) as f: 240 | logging.debug("TeX-9: Reading BibTeX entries from `{0}'".format(path.basename(fname))) 241 | return re.findall('^@\w+ *{\s*([^, ]+) *,', f.read(), re.M) 242 | 243 | except IOError: 244 | echoerr(messages["INVALID_BIBFILE"].format(fname)) 245 | return [] 246 | 247 | @property 248 | def bibpaths(self): 249 | return self.get_bibpaths(vim.current.buffer) 250 | 251 | @bibpaths.setter 252 | def set_bibpaths(self, paths): 253 | for p in paths: 254 | self._bibpaths.add(p) 255 | self._bibcompletions = [] 256 | return 257 | 258 | @property 259 | def bibentries(self): 260 | return self.get_bibentries() 261 | 262 | # Lazy load 263 | @TeXNineBase.multi_file 264 | def get_bibpaths(self, vimbuffer, update=False): 265 | """Returns the BibTeX files in a LaTeX project. 266 | 267 | Reads the master file to find out the names of BibTeX files. 268 | Files in the compilation folder take precedence over files 269 | located in a TDS tree[1]. 270 | 271 | * Requires the program ``kpsewhich'' 272 | that is shipped with the standard TeXLive distribution. 273 | 274 | [1] http://www.tug.org/tds/tds.html#BibTeX 275 | """ 276 | 277 | if not self._bibpaths or update: 278 | # Find out the bibfiles in use 279 | master = vimbuffer.name 280 | masterbuffer = "\n".join(vimbuffer[:]) 281 | if not masterbuffer: 282 | e = messages['MASTER_NOT_ACTIVE'].format(path.basename(master)) 283 | raise TeXNineError(e) 284 | else: 285 | match = re.search(r'\\bibliography{([^}]+)}', 286 | masterbuffer) 287 | if not match: 288 | e = messages['NO_BIBTEX'] 289 | raise TeXNineError(e) 290 | 291 | bibfiles = match.group(1).split(',') 292 | dirname = path.dirname(master) 293 | # Find the absolute paths of the bibfiles 294 | for b in bibfiles: 295 | b += '.bib' 296 | # Check if the bibfile is in the compilation folder 297 | bibtemp = path.join(dirname, b) 298 | b = ( bibtemp if path.exists(bibtemp) else b ) 299 | # Get the path with kspewhich 300 | proc = subprocess.Popen(['kpsewhich','-must-exist', b], 301 | stdout=subprocess.PIPE) 302 | bibpath = proc.communicate()[0].strip('\n') 303 | # kpsewhich return either the full path or an empty 304 | # string. 305 | if bibpath: 306 | self._bibpaths.add(bibpath) 307 | else: 308 | raise TeXNineError(messages["INVALID_BIBFILE"].format(b)) 309 | 310 | return list(self._bibpaths) 311 | 312 | def get_bibentries(self): 313 | """Returns a list of BibTeX entries found in the BibTeX files.""" 314 | if not self._bibcompletions: 315 | bibpaths = self.get_bibpaths(vim.current.buffer) 316 | for b in bibpaths: 317 | self._bibcompletions += self._bibparser(b) 318 | return self._bibcompletions 319 | 320 | def update(self, bibpaths=[]): 321 | self._bibcompletions = [] 322 | self._bibpaths.clear() 323 | if bibpaths: 324 | for p in bibpaths: 325 | self._bibpaths.add(p) 326 | else: 327 | self.get_bibpaths(vim.current.buffer, update=True) 328 | 329 | class TeXNineOmni(TeXNineBibTeX): 330 | """Vim's omni completion for a LaTeX document. 331 | 332 | findstart() finds the position where completion should start and 333 | stores the relevant `keyword'. An appropiate list is then returned 334 | based on the keyword. 335 | 336 | Following items are completed via omni completion 337 | 338 | * BibTeX entries 339 | * Labels for cross-references 340 | * Font names when using `fontspec' or 'unicode-math' 341 | * Picture names when using `graphicx' (EPS, PNG, JPG, PDF) 342 | 343 | """ 344 | 345 | def __init__(self, bibfiles=[]): 346 | self.keyword = None 347 | 348 | @TeXNineBase.multi_file 349 | def _labels(self, vimbuffer, 350 | pat=re.compile(r'\\label{(?P