Overview
jQuery.Feyn is a jQuery plugin to facilitate your drawing Feynman diagrams with Scalable Vector Graphics (SVG). The following list gives a quick overview of the most prominent features:
- Automatic generation of clean SVG source code
- Easy to use, easy to make fine adjustments
- Predefined propagator styles, vertex types, and symbols
- Support for typesetting labels and including external graphics
- Lightweight, cross-browser, and fully documented
I have tried my best to embrace the tagline of jQuery: write less, do more. You can view the source code on GitHub or directly in your browser. jQuery.Feyn is released under the MIT license. By the way, I initiated this project so as to replace the PNG format Feynman diagrams in Wikimedia Commons. It is also used on the website arXiv Analytics to generate SVG diagrams for the reviews. You may would like to use it for preparing your papers. If convenient, please link to this site or cite my arXiv e-print to show your support. Thank you.
Getting Started
You can start your tour from jQuery.Feyn's online demo and view its source by pressing Ctrl+U. Settings for Feynman diagrams are in the form of JavaScript's liberal object notation, whose simplicity and extensibility has already made it possible for jQuery.Feyn to be lightweight and powerful. I hope that you will enjoy this feature if it is still new to you. Knowledge on jQuery is not necessary to use jQuery.Feyn, but getting a feel of JavaScript syntax will make your exploration easier. More importantly, you should be familiar with SVG markup language.
Supported Browsers
Any modern browsers for desktop or mobile with a basic support of HTML5 and SVG 1.1 in the standards mode should be OK to run jQuery.Feyn. However, we do not guarantee that all of them will display the same SVG exactly on your screen due to their differences in SVG rendering. Also note that mobile browsers often show a lot of quirks that are hard to work around because of their limitations and different UI assumptions. The following provides an incomplete list of supported browsers:
- Firefox 4+
- Chrome 7+
- Opera 11.6+
- Safari 5.1+
- IE 9+
A more detailed compatibility table for support of inline SVG in HTML5 can be found at caniuse.com/svg-html5. Personaly, I recommend Firefox 24+ and Chrome 28+, on which my testing will be conducted continually.
Bug Reports and Feedback
The preferred way to report bugs is to use the GitHub issue tracker. Before reporting a bug, please ensure that you have tested the bug on Firefox 24+ and Chrome 28+. Technical comments and requests for adding more features are also welcome. Please e-mail me at panzan89.phys@gmail.com.
About the Author
I am currently a graduate student in the Institute of Theoretical Physics at Chinese Academy of Sciences, with the research emphasis on high energy phenomenology. You can contact me at panzan.phys@itp.ac.cn.
