burp_cms 1.3.13 → 1.3.14
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Rakefile +2 -2
- data/app/assets/images/burp/add-image-2.jpg +0 -0
- data/app/assets/images/burp/add-image-3.jpg +0 -0
- data/app/assets/images/burp/add-image-4.jpg +0 -0
- data/app/assets/images/burp/enter-page-edit-mode-4.jpg +0 -0
- data/app/assets/images/burp/remove-image-2.jpg +0 -0
- data/app/assets/images/burp/remove-image-3.jpg +0 -0
- data/app/assets/images/burp/remove-image-4.jpg +0 -0
- data/app/assets/images/burp/remove-image-5.jpg +0 -0
- data/app/views/burp/static/help.html.erb +8 -8
- data/lib/burp/version.rb +1 -1
- metadata +95 -234
- data/app/assets/images/burp/add-image-2.png +0 -0
- data/app/assets/images/burp/add-image-3.png +0 -0
- data/app/assets/images/burp/add-image-4.png +0 -0
- data/app/assets/images/burp/enter-page-edit-mode-4.png +0 -0
- data/app/assets/images/burp/remove-image-2.png +0 -0
- data/app/assets/images/burp/remove-image-3.png +0 -0
- data/app/assets/images/burp/remove-image-4.png +0 -0
- data/app/assets/images/burp/remove-image-5.png +0 -0
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/README.md +0 -8
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/activeline.html +0 -72
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/changemode.html +0 -50
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/closetag.html +0 -65
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/complete.html +0 -70
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/emacs.html +0 -59
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/folding.html +0 -61
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/formatting.html +0 -80
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/fullscreen.html +0 -152
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/loadmode.html +0 -39
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/marker.html +0 -52
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/matchhighlighter.html +0 -37
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/multiplex.html +0 -59
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/mustache.html +0 -57
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/preview.html +0 -76
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/resize.html +0 -41
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/runmode.html +0 -49
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/search.html +0 -83
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/theme.html +0 -78
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/vim.html +0 -50
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/demo/visibletabs.html +0 -61
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/baboon.png +0 -0
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/baboon_vector.svg +0 -153
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/compress.html +0 -148
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/docs.css +0 -154
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/internals.html +0 -494
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/manual.html +0 -1128
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/oldrelease.html +0 -267
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/reporting.html +0 -57
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/doc/upgrade_v2.2.html +0 -95
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/index.html +0 -417
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/clike/clike.js +0 -271
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/clike/index.html +0 -101
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/clike/scala.html +0 -765
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/clojure/clojure.js +0 -207
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/clojure/index.html +0 -66
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/coffeescript/LICENSE +0 -22
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/coffeescript/coffeescript.js +0 -347
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/coffeescript/index.html +0 -727
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/diff/diff.js +0 -32
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/diff/index.html +0 -104
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ecl/ecl.js +0 -203
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ecl/index.html +0 -42
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/erlang/erlang.js +0 -251
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/erlang/index.html +0 -61
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/gfm/gfm.js +0 -144
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/gfm/index.html +0 -47
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/go/go.js +0 -170
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/go/index.html +0 -72
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/groovy/groovy.js +0 -210
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/groovy/index.html +0 -71
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/haskell/haskell.js +0 -242
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/haskell/index.html +0 -60
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/jinja2/index.html +0 -37
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/jinja2/jinja2.js +0 -42
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/less/index.html +0 -618
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/less/less.js +0 -232
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/lua/index.html +0 -72
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/lua/lua.js +0 -140
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/mysql/index.html +0 -41
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/mysql/mysql.js +0 -188
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ntriples/index.html +0 -32
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ntriples/ntriples.js +0 -172
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/pascal/LICENSE +0 -7
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/pascal/index.html +0 -48
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/pascal/pascal.js +0 -94
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/perl/LICENSE +0 -19
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/perl/index.html +0 -62
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/perl/perl.js +0 -816
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/php/index.html +0 -48
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/php/php.js +0 -150
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/pig/index.html +0 -42
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/pig/pig.js +0 -172
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/plsql/index.html +0 -62
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/plsql/plsql.js +0 -217
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/properties/index.html +0 -40
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/properties/properties.js +0 -63
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/python/LICENSE.txt +0 -21
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/python/index.html +0 -122
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/python/python.js +0 -338
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/r/LICENSE +0 -24
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/r/index.html +0 -73
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/r/r.js +0 -141
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rpm/changes/changes.js +0 -19
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rpm/changes/index.html +0 -53
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rpm/spec/index.html +0 -99
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rpm/spec/spec.css +0 -5
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rpm/spec/spec.js +0 -66
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rst/index.html +0 -525
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rst/rst.js +0 -326
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ruby/LICENSE +0 -24
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ruby/index.html +0 -171
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/ruby/ruby.js +0 -195
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rust/index.html +0 -48
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/rust/rust.js +0 -432
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/scheme/index.html +0 -64
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/scheme/scheme.js +0 -230
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/shell/index.html +0 -50
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/shell/shell.js +0 -103
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/smalltalk/index.html +0 -55
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/smalltalk/smalltalk.js +0 -139
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/smarty/index.html +0 -82
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/smarty/smarty.js +0 -148
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/sparql/index.html +0 -40
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/sparql/sparql.js +0 -143
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/stex/index.html +0 -95
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/stex/stex.js +0 -182
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/stex/test.html +0 -263
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiddlywiki/index.html +0 -140
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiddlywiki/tiddlywiki.css +0 -14
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiddlywiki/tiddlywiki.js +0 -384
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiki/index.html +0 -82
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiki/tiki.css +0 -26
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/tiki/tiki.js +0 -316
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/vbscript/index.html +0 -42
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/vbscript/vbscript.js +0 -26
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/velocity/index.html +0 -103
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/velocity/velocity.js +0 -146
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/verilog/index.html +0 -210
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/verilog/verilog.js +0 -194
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/LICENSE +0 -20
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/index.html +0 -222
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/index.html +0 -27
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testBase.js +0 -42
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testEmptySequenceKeyword.js +0 -16
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testMultiAttr.js +0 -16
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testNamespaces.js +0 -91
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testProcessingInstructions.js +0 -16
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/test/testQuotes.js +0 -19
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/xquery/xquery.js +0 -448
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/yaml/index.html +0 -67
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/mode/yaml/yaml.js +0 -95
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/test/index.html +0 -28
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/test/mode_test.css +0 -22
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/test/mode_test.js +0 -164
- data/app/assets/packages/burp/editing/dep/CodeMirror-2.3/test/test.js +0 -344
- data/app/assets/packages/burp/editing/dep/FontAwesome/FontAwesome-Vectors.pdf +11 -3176
- data/app/assets/packages/burp/editing/dep/FontAwesome/FontAwesome.ttf +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/README.md +0 -18
- data/app/assets/packages/burp/editing/dep/FontAwesome/css/font-awesome-ie7.css +0 -645
- data/app/assets/packages/burp/editing/dep/FontAwesome/css/font-awesome.less +0 -309
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/css/font-awesome-ie7.css +0 -213
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/css/font-awesome.css +0 -303
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/css/prettify.css +0 -30
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/css/site.css +0 -4904
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/fontawesome-webfont.eot +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/fontawesome-webfont.svg +0 -255
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/fontawesome-webfont.ttf +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/fontawesome-webfont.woff +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/museo_slab_300-webfont.eot +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/museo_slab_300-webfont.ttf +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/museo_slab_500-webfont.eot +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/museo_slab_500-webfont.ttf +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/proximanova-webfont.eot +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/font/proximanova-webfont.ttf +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/ico/favicon.ico +0 -0
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/backbone.min.js +0 -37
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/index/index.js +0 -89
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/jquery-1.7.1.min.js +0 -4
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/prettify.min.js +0 -28
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-alert.js +0 -94
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-button.js +0 -98
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-carousel.js +0 -157
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-collapse.js +0 -136
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-dropdown.js +0 -92
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-modal.js +0 -210
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-popover.js +0 -95
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-scrollspy.js +0 -125
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-tab.js +0 -130
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-tooltip.js +0 -270
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-transition.js +0 -51
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/tw-bs-201/bootstrap-typeahead.js +0 -271
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/js/underscore.min.js +0 -31
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/font-awesome-ie7.less +0 -245
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/font-awesome.less +0 -327
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/font-site.less +0 -26
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/mixins.less +0 -43
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/site.less +0 -300
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/accordion.less +0 -33
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/alerts.less +0 -58
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/bootstrap.less +0 -62
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/breadcrumbs.less +0 -24
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/button-groups.less +0 -191
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/buttons.less +0 -191
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/carousel.less +0 -121
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/close.less +0 -29
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/code.less +0 -57
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/component-animations.less +0 -20
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/dropdowns.less +0 -143
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/forms.less +0 -584
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/grid.less +0 -5
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/hero-unit.less +0 -22
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/labels-badges.less +0 -55
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/layouts.less +0 -17
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/mixins.less +0 -631
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/modals.less +0 -90
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/navbar.less +0 -364
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/navs.less +0 -363
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/pager.less +0 -36
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/pagination.less +0 -56
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/popovers.less +0 -49
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/progress-bars.less +0 -117
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/reset.less +0 -126
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive-1200px-min.less +0 -26
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive-767px-max.less +0 -149
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive-768px-979px.less +0 -17
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive-navbar.less +0 -146
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive-utilities.less +0 -41
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/responsive.less +0 -48
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/scaffolding.less +0 -29
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/sprites.less +0 -191
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/tables.less +0 -176
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/thumbnails.less +0 -47
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/tooltip.less +0 -35
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/type.less +0 -235
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/utilities.less +0 -23
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/variables.less +0 -205
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/twbs-203/wells.less +0 -27
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/assets/less/variables.less +0 -206
- data/app/assets/packages/burp/editing/dep/FontAwesome/docs/index.html +0 -1087
- data/app/assets/packages/burp/editing/dep/FontAwesome/sass/font-awesome.sass +0 -712
- data/app/assets/packages/burp/editing/dep/FontAwesome/sass/font-awesome.scss +0 -329
@@ -1,525 +0,0 @@
|
|
1
|
-
<!doctype html>
|
2
|
-
<html>
|
3
|
-
<head>
|
4
|
-
<title>CodeMirror: reStructuredText mode</title>
|
5
|
-
<link rel="stylesheet" href="../../lib/codemirror.css">
|
6
|
-
<script src="../../lib/codemirror.js"></script>
|
7
|
-
<script src="rst.js"></script>
|
8
|
-
<style type="text/css">.CodeMirror {border-top: 1px solid black; border-bottom: 1px solid black;}</style>
|
9
|
-
<link rel="stylesheet" href="../../doc/docs.css">
|
10
|
-
</head>
|
11
|
-
<body>
|
12
|
-
<h1>CodeMirror: reStructuredText mode</h1>
|
13
|
-
|
14
|
-
<form><textarea id="code" name="code">
|
15
|
-
.. This is an excerpt from Sphinx documentation: http://sphinx.pocoo.org/_sources/rest.txt
|
16
|
-
|
17
|
-
.. highlightlang:: rest
|
18
|
-
|
19
|
-
.. _rst-primer:
|
20
|
-
|
21
|
-
reStructuredText Primer
|
22
|
-
=======================
|
23
|
-
|
24
|
-
This section is a brief introduction to reStructuredText (reST) concepts and
|
25
|
-
syntax, intended to provide authors with enough information to author documents
|
26
|
-
productively. Since reST was designed to be a simple, unobtrusive markup
|
27
|
-
language, this will not take too long.
|
28
|
-
|
29
|
-
.. seealso::
|
30
|
-
|
31
|
-
The authoritative `reStructuredText User Documentation
|
32
|
-
<http://docutils.sourceforge.net/rst.html>`_. The "ref" links in this
|
33
|
-
document link to the description of the individual constructs in the reST
|
34
|
-
reference.
|
35
|
-
|
36
|
-
|
37
|
-
Paragraphs
|
38
|
-
----------
|
39
|
-
|
40
|
-
The paragraph (:duref:`ref <paragraphs>`) is the most basic block in a reST
|
41
|
-
document. Paragraphs are simply chunks of text separated by one or more blank
|
42
|
-
lines. As in Python, indentation is significant in reST, so all lines of the
|
43
|
-
same paragraph must be left-aligned to the same level of indentation.
|
44
|
-
|
45
|
-
|
46
|
-
.. _inlinemarkup:
|
47
|
-
|
48
|
-
Inline markup
|
49
|
-
-------------
|
50
|
-
|
51
|
-
The standard reST inline markup is quite simple: use
|
52
|
-
|
53
|
-
* one asterisk: ``*text*`` for emphasis (italics),
|
54
|
-
* two asterisks: ``**text**`` for strong emphasis (boldface), and
|
55
|
-
* backquotes: ````text```` for code samples.
|
56
|
-
|
57
|
-
If asterisks or backquotes appear in running text and could be confused with
|
58
|
-
inline markup delimiters, they have to be escaped with a backslash.
|
59
|
-
|
60
|
-
Be aware of some restrictions of this markup:
|
61
|
-
|
62
|
-
* it may not be nested,
|
63
|
-
* content may not start or end with whitespace: ``* text*`` is wrong,
|
64
|
-
* it must be separated from surrounding text by non-word characters. Use a
|
65
|
-
backslash escaped space to work around that: ``thisis\ *one*\ word``.
|
66
|
-
|
67
|
-
These restrictions may be lifted in future versions of the docutils.
|
68
|
-
|
69
|
-
reST also allows for custom "interpreted text roles"', which signify that the
|
70
|
-
enclosed text should be interpreted in a specific way. Sphinx uses this to
|
71
|
-
provide semantic markup and cross-referencing of identifiers, as described in
|
72
|
-
the appropriate section. The general syntax is ``:rolename:`content```.
|
73
|
-
|
74
|
-
Standard reST provides the following roles:
|
75
|
-
|
76
|
-
* :durole:`emphasis` -- alternate spelling for ``*emphasis*``
|
77
|
-
* :durole:`strong` -- alternate spelling for ``**strong**``
|
78
|
-
* :durole:`literal` -- alternate spelling for ````literal````
|
79
|
-
* :durole:`subscript` -- subscript text
|
80
|
-
* :durole:`superscript` -- superscript text
|
81
|
-
* :durole:`title-reference` -- for titles of books, periodicals, and other
|
82
|
-
materials
|
83
|
-
|
84
|
-
See :ref:`inline-markup` for roles added by Sphinx.
|
85
|
-
|
86
|
-
|
87
|
-
Lists and Quote-like blocks
|
88
|
-
---------------------------
|
89
|
-
|
90
|
-
List markup (:duref:`ref <bullet-lists>`) is natural: just place an asterisk at
|
91
|
-
the start of a paragraph and indent properly. The same goes for numbered lists;
|
92
|
-
they can also be autonumbered using a ``#`` sign::
|
93
|
-
|
94
|
-
* This is a bulleted list.
|
95
|
-
* It has two items, the second
|
96
|
-
item uses two lines.
|
97
|
-
|
98
|
-
1. This is a numbered list.
|
99
|
-
2. It has two items too.
|
100
|
-
|
101
|
-
#. This is a numbered list.
|
102
|
-
#. It has two items too.
|
103
|
-
|
104
|
-
|
105
|
-
Nested lists are possible, but be aware that they must be separated from the
|
106
|
-
parent list items by blank lines::
|
107
|
-
|
108
|
-
* this is
|
109
|
-
* a list
|
110
|
-
|
111
|
-
* with a nested list
|
112
|
-
* and some subitems
|
113
|
-
|
114
|
-
* and here the parent list continues
|
115
|
-
|
116
|
-
Definition lists (:duref:`ref <definition-lists>`) are created as follows::
|
117
|
-
|
118
|
-
term (up to a line of text)
|
119
|
-
Definition of the term, which must be indented
|
120
|
-
|
121
|
-
and can even consist of multiple paragraphs
|
122
|
-
|
123
|
-
next term
|
124
|
-
Description.
|
125
|
-
|
126
|
-
Note that the term cannot have more than one line of text.
|
127
|
-
|
128
|
-
Quoted paragraphs (:duref:`ref <block-quotes>`) are created by just indenting
|
129
|
-
them more than the surrounding paragraphs.
|
130
|
-
|
131
|
-
Line blocks (:duref:`ref <line-blocks>`) are a way of preserving line breaks::
|
132
|
-
|
133
|
-
| These lines are
|
134
|
-
| broken exactly like in
|
135
|
-
| the source file.
|
136
|
-
|
137
|
-
There are also several more special blocks available:
|
138
|
-
|
139
|
-
* field lists (:duref:`ref <field-lists>`)
|
140
|
-
* option lists (:duref:`ref <option-lists>`)
|
141
|
-
* quoted literal blocks (:duref:`ref <quoted-literal-blocks>`)
|
142
|
-
* doctest blocks (:duref:`ref <doctest-blocks>`)
|
143
|
-
|
144
|
-
|
145
|
-
Source Code
|
146
|
-
-----------
|
147
|
-
|
148
|
-
Literal code blocks (:duref:`ref <literal-blocks>`) are introduced by ending a
|
149
|
-
paragraph with the special marker ``::``. The literal block must be indented
|
150
|
-
(and, like all paragraphs, separated from the surrounding ones by blank lines)::
|
151
|
-
|
152
|
-
This is a normal text paragraph. The next paragraph is a code sample::
|
153
|
-
|
154
|
-
It is not processed in any way, except
|
155
|
-
that the indentation is removed.
|
156
|
-
|
157
|
-
It can span multiple lines.
|
158
|
-
|
159
|
-
This is a normal text paragraph again.
|
160
|
-
|
161
|
-
The handling of the ``::`` marker is smart:
|
162
|
-
|
163
|
-
* If it occurs as a paragraph of its own, that paragraph is completely left
|
164
|
-
out of the document.
|
165
|
-
* If it is preceded by whitespace, the marker is removed.
|
166
|
-
* If it is preceded by non-whitespace, the marker is replaced by a single
|
167
|
-
colon.
|
168
|
-
|
169
|
-
That way, the second sentence in the above example's first paragraph would be
|
170
|
-
rendered as "The next paragraph is a code sample:".
|
171
|
-
|
172
|
-
|
173
|
-
.. _rst-tables:
|
174
|
-
|
175
|
-
Tables
|
176
|
-
------
|
177
|
-
|
178
|
-
Two forms of tables are supported. For *grid tables* (:duref:`ref
|
179
|
-
<grid-tables>`), you have to "paint" the cell grid yourself. They look like
|
180
|
-
this::
|
181
|
-
|
182
|
-
+------------------------+------------+----------+----------+
|
183
|
-
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
|
184
|
-
| (header rows optional) | | | |
|
185
|
-
+========================+============+==========+==========+
|
186
|
-
| body row 1, column 1 | column 2 | column 3 | column 4 |
|
187
|
-
+------------------------+------------+----------+----------+
|
188
|
-
| body row 2 | ... | ... | |
|
189
|
-
+------------------------+------------+----------+----------+
|
190
|
-
|
191
|
-
*Simple tables* (:duref:`ref <simple-tables>`) are easier to write, but
|
192
|
-
limited: they must contain more than one row, and the first column cannot
|
193
|
-
contain multiple lines. They look like this::
|
194
|
-
|
195
|
-
===== ===== =======
|
196
|
-
A B A and B
|
197
|
-
===== ===== =======
|
198
|
-
False False False
|
199
|
-
True False False
|
200
|
-
False True False
|
201
|
-
True True True
|
202
|
-
===== ===== =======
|
203
|
-
|
204
|
-
|
205
|
-
Hyperlinks
|
206
|
-
----------
|
207
|
-
|
208
|
-
External links
|
209
|
-
^^^^^^^^^^^^^^
|
210
|
-
|
211
|
-
Use ```Link text <http://example.com/>`_`` for inline web links. If the link
|
212
|
-
text should be the web address, you don't need special markup at all, the parser
|
213
|
-
finds links and mail addresses in ordinary text.
|
214
|
-
|
215
|
-
You can also separate the link and the target definition (:duref:`ref
|
216
|
-
<hyperlink-targets>`), like this::
|
217
|
-
|
218
|
-
This is a paragraph that contains `a link`_.
|
219
|
-
|
220
|
-
.. _a link: http://example.com/
|
221
|
-
|
222
|
-
|
223
|
-
Internal links
|
224
|
-
^^^^^^^^^^^^^^
|
225
|
-
|
226
|
-
Internal linking is done via a special reST role provided by Sphinx, see the
|
227
|
-
section on specific markup, :ref:`ref-role`.
|
228
|
-
|
229
|
-
|
230
|
-
Sections
|
231
|
-
--------
|
232
|
-
|
233
|
-
Section headers (:duref:`ref <sections>`) are created by underlining (and
|
234
|
-
optionally overlining) the section title with a punctuation character, at least
|
235
|
-
as long as the text::
|
236
|
-
|
237
|
-
=================
|
238
|
-
This is a heading
|
239
|
-
=================
|
240
|
-
|
241
|
-
Normally, there are no heading levels assigned to certain characters as the
|
242
|
-
structure is determined from the succession of headings. However, for the
|
243
|
-
Python documentation, this convention is used which you may follow:
|
244
|
-
|
245
|
-
* ``#`` with overline, for parts
|
246
|
-
* ``*`` with overline, for chapters
|
247
|
-
* ``=``, for sections
|
248
|
-
* ``-``, for subsections
|
249
|
-
* ``^``, for subsubsections
|
250
|
-
* ``"``, for paragraphs
|
251
|
-
|
252
|
-
Of course, you are free to use your own marker characters (see the reST
|
253
|
-
documentation), and use a deeper nesting level, but keep in mind that most
|
254
|
-
target formats (HTML, LaTeX) have a limited supported nesting depth.
|
255
|
-
|
256
|
-
|
257
|
-
Explicit Markup
|
258
|
-
---------------
|
259
|
-
|
260
|
-
"Explicit markup" (:duref:`ref <explicit-markup-blocks>`) is used in reST for
|
261
|
-
most constructs that need special handling, such as footnotes,
|
262
|
-
specially-highlighted paragraphs, comments, and generic directives.
|
263
|
-
|
264
|
-
An explicit markup block begins with a line starting with ``..`` followed by
|
265
|
-
whitespace and is terminated by the next paragraph at the same level of
|
266
|
-
indentation. (There needs to be a blank line between explicit markup and normal
|
267
|
-
paragraphs. This may all sound a bit complicated, but it is intuitive enough
|
268
|
-
when you write it.)
|
269
|
-
|
270
|
-
|
271
|
-
.. _directives:
|
272
|
-
|
273
|
-
Directives
|
274
|
-
----------
|
275
|
-
|
276
|
-
A directive (:duref:`ref <directives>`) is a generic block of explicit markup.
|
277
|
-
Besides roles, it is one of the extension mechanisms of reST, and Sphinx makes
|
278
|
-
heavy use of it.
|
279
|
-
|
280
|
-
Docutils supports the following directives:
|
281
|
-
|
282
|
-
* Admonitions: :dudir:`attention`, :dudir:`caution`, :dudir:`danger`,
|
283
|
-
:dudir:`error`, :dudir:`hint`, :dudir:`important`, :dudir:`note`,
|
284
|
-
:dudir:`tip`, :dudir:`warning` and the generic :dudir:`admonition`.
|
285
|
-
(Most themes style only "note" and "warning" specially.)
|
286
|
-
|
287
|
-
* Images:
|
288
|
-
|
289
|
-
- :dudir:`image` (see also Images_ below)
|
290
|
-
- :dudir:`figure` (an image with caption and optional legend)
|
291
|
-
|
292
|
-
* Additional body elements:
|
293
|
-
|
294
|
-
- :dudir:`contents` (a local, i.e. for the current file only, table of
|
295
|
-
contents)
|
296
|
-
- :dudir:`container` (a container with a custom class, useful to generate an
|
297
|
-
outer ``<div>`` in HTML)
|
298
|
-
- :dudir:`rubric` (a heading without relation to the document sectioning)
|
299
|
-
- :dudir:`topic`, :dudir:`sidebar` (special highlighted body elements)
|
300
|
-
- :dudir:`parsed-literal` (literal block that supports inline markup)
|
301
|
-
- :dudir:`epigraph` (a block quote with optional attribution line)
|
302
|
-
- :dudir:`highlights`, :dudir:`pull-quote` (block quotes with their own
|
303
|
-
class attribute)
|
304
|
-
- :dudir:`compound` (a compound paragraph)
|
305
|
-
|
306
|
-
* Special tables:
|
307
|
-
|
308
|
-
- :dudir:`table` (a table with title)
|
309
|
-
- :dudir:`csv-table` (a table generated from comma-separated values)
|
310
|
-
- :dudir:`list-table` (a table generated from a list of lists)
|
311
|
-
|
312
|
-
* Special directives:
|
313
|
-
|
314
|
-
- :dudir:`raw` (include raw target-format markup)
|
315
|
-
- :dudir:`include` (include reStructuredText from another file)
|
316
|
-
-- in Sphinx, when given an absolute include file path, this directive takes
|
317
|
-
it as relative to the source directory
|
318
|
-
- :dudir:`class` (assign a class attribute to the next element) [1]_
|
319
|
-
|
320
|
-
* HTML specifics:
|
321
|
-
|
322
|
-
- :dudir:`meta` (generation of HTML ``<meta>`` tags)
|
323
|
-
- :dudir:`title` (override document title)
|
324
|
-
|
325
|
-
* Influencing markup:
|
326
|
-
|
327
|
-
- :dudir:`default-role` (set a new default role)
|
328
|
-
- :dudir:`role` (create a new role)
|
329
|
-
|
330
|
-
Since these are only per-file, better use Sphinx' facilities for setting the
|
331
|
-
:confval:`default_role`.
|
332
|
-
|
333
|
-
Do *not* use the directives :dudir:`sectnum`, :dudir:`header` and
|
334
|
-
:dudir:`footer`.
|
335
|
-
|
336
|
-
Directives added by Sphinx are described in :ref:`sphinxmarkup`.
|
337
|
-
|
338
|
-
Basically, a directive consists of a name, arguments, options and content. (Keep
|
339
|
-
this terminology in mind, it is used in the next chapter describing custom
|
340
|
-
directives.) Looking at this example, ::
|
341
|
-
|
342
|
-
.. function:: foo(x)
|
343
|
-
foo(y, z)
|
344
|
-
:module: some.module.name
|
345
|
-
|
346
|
-
Return a line of text input from the user.
|
347
|
-
|
348
|
-
``function`` is the directive name. It is given two arguments here, the
|
349
|
-
remainder of the first line and the second line, as well as one option
|
350
|
-
``module`` (as you can see, options are given in the lines immediately following
|
351
|
-
the arguments and indicated by the colons). Options must be indented to the
|
352
|
-
same level as the directive content.
|
353
|
-
|
354
|
-
The directive content follows after a blank line and is indented relative to the
|
355
|
-
directive start.
|
356
|
-
|
357
|
-
|
358
|
-
Images
|
359
|
-
------
|
360
|
-
|
361
|
-
reST supports an image directive (:dudir:`ref <image>`), used like so::
|
362
|
-
|
363
|
-
.. image:: gnu.png
|
364
|
-
(options)
|
365
|
-
|
366
|
-
When used within Sphinx, the file name given (here ``gnu.png``) must either be
|
367
|
-
relative to the source file, or absolute which means that they are relative to
|
368
|
-
the top source directory. For example, the file ``sketch/spam.rst`` could refer
|
369
|
-
to the image ``images/spam.png`` as ``../images/spam.png`` or
|
370
|
-
``/images/spam.png``.
|
371
|
-
|
372
|
-
Sphinx will automatically copy image files over to a subdirectory of the output
|
373
|
-
directory on building (e.g. the ``_static`` directory for HTML output.)
|
374
|
-
|
375
|
-
Interpretation of image size options (``width`` and ``height``) is as follows:
|
376
|
-
if the size has no unit or the unit is pixels, the given size will only be
|
377
|
-
respected for output channels that support pixels (i.e. not in LaTeX output).
|
378
|
-
Other units (like ``pt`` for points) will be used for HTML and LaTeX output.
|
379
|
-
|
380
|
-
Sphinx extends the standard docutils behavior by allowing an asterisk for the
|
381
|
-
extension::
|
382
|
-
|
383
|
-
.. image:: gnu.*
|
384
|
-
|
385
|
-
Sphinx then searches for all images matching the provided pattern and determines
|
386
|
-
their type. Each builder then chooses the best image out of these candidates.
|
387
|
-
For instance, if the file name ``gnu.*`` was given and two files :file:`gnu.pdf`
|
388
|
-
and :file:`gnu.png` existed in the source tree, the LaTeX builder would choose
|
389
|
-
the former, while the HTML builder would prefer the latter.
|
390
|
-
|
391
|
-
.. versionchanged:: 0.4
|
392
|
-
Added the support for file names ending in an asterisk.
|
393
|
-
|
394
|
-
.. versionchanged:: 0.6
|
395
|
-
Image paths can now be absolute.
|
396
|
-
|
397
|
-
|
398
|
-
Footnotes
|
399
|
-
---------
|
400
|
-
|
401
|
-
For footnotes (:duref:`ref <footnotes>`), use ``[#name]_`` to mark the footnote
|
402
|
-
location, and add the footnote body at the bottom of the document after a
|
403
|
-
"Footnotes" rubric heading, like so::
|
404
|
-
|
405
|
-
Lorem ipsum [#f1]_ dolor sit amet ... [#f2]_
|
406
|
-
|
407
|
-
.. rubric:: Footnotes
|
408
|
-
|
409
|
-
.. [#f1] Text of the first footnote.
|
410
|
-
.. [#f2] Text of the second footnote.
|
411
|
-
|
412
|
-
You can also explicitly number the footnotes (``[1]_``) or use auto-numbered
|
413
|
-
footnotes without names (``[#]_``).
|
414
|
-
|
415
|
-
|
416
|
-
Citations
|
417
|
-
---------
|
418
|
-
|
419
|
-
Standard reST citations (:duref:`ref <citations>`) are supported, with the
|
420
|
-
additional feature that they are "global", i.e. all citations can be referenced
|
421
|
-
from all files. Use them like so::
|
422
|
-
|
423
|
-
Lorem ipsum [Ref]_ dolor sit amet.
|
424
|
-
|
425
|
-
.. [Ref] Book or article reference, URL or whatever.
|
426
|
-
|
427
|
-
Citation usage is similar to footnote usage, but with a label that is not
|
428
|
-
numeric or begins with ``#``.
|
429
|
-
|
430
|
-
|
431
|
-
Substitutions
|
432
|
-
-------------
|
433
|
-
|
434
|
-
reST supports "substitutions" (:duref:`ref <substitution-definitions>`), which
|
435
|
-
are pieces of text and/or markup referred to in the text by ``|name|``. They
|
436
|
-
are defined like footnotes with explicit markup blocks, like this::
|
437
|
-
|
438
|
-
.. |name| replace:: replacement *text*
|
439
|
-
|
440
|
-
or this::
|
441
|
-
|
442
|
-
.. |caution| image:: warning.png
|
443
|
-
:alt: Warning!
|
444
|
-
|
445
|
-
See the :duref:`reST reference for substitutions <substitution-definitions>`
|
446
|
-
for details.
|
447
|
-
|
448
|
-
If you want to use some substitutions for all documents, put them into
|
449
|
-
:confval:`rst_prolog` or put them into a separate file and include it into all
|
450
|
-
documents you want to use them in, using the :rst:dir:`include` directive. (Be
|
451
|
-
sure to give the include file a file name extension differing from that of other
|
452
|
-
source files, to avoid Sphinx finding it as a standalone document.)
|
453
|
-
|
454
|
-
Sphinx defines some default substitutions, see :ref:`default-substitutions`.
|
455
|
-
|
456
|
-
|
457
|
-
Comments
|
458
|
-
--------
|
459
|
-
|
460
|
-
Every explicit markup block which isn't a valid markup construct (like the
|
461
|
-
footnotes above) is regarded as a comment (:duref:`ref <comments>`). For
|
462
|
-
example::
|
463
|
-
|
464
|
-
.. This is a comment.
|
465
|
-
|
466
|
-
You can indent text after a comment start to form multiline comments::
|
467
|
-
|
468
|
-
..
|
469
|
-
This whole indented block
|
470
|
-
is a comment.
|
471
|
-
|
472
|
-
Still in the comment.
|
473
|
-
|
474
|
-
|
475
|
-
Source encoding
|
476
|
-
---------------
|
477
|
-
|
478
|
-
Since the easiest way to include special characters like em dashes or copyright
|
479
|
-
signs in reST is to directly write them as Unicode characters, one has to
|
480
|
-
specify an encoding. Sphinx assumes source files to be encoded in UTF-8 by
|
481
|
-
default; you can change this with the :confval:`source_encoding` config value.
|
482
|
-
|
483
|
-
|
484
|
-
Gotchas
|
485
|
-
-------
|
486
|
-
|
487
|
-
There are some problems one commonly runs into while authoring reST documents:
|
488
|
-
|
489
|
-
* **Separation of inline markup:** As said above, inline markup spans must be
|
490
|
-
separated from the surrounding text by non-word characters, you have to use a
|
491
|
-
backslash-escaped space to get around that. See `the reference
|
492
|
-
<http://docutils.sf.net/docs/ref/rst/restructuredtext.html#inline-markup>`_
|
493
|
-
for the details.
|
494
|
-
|
495
|
-
* **No nested inline markup:** Something like ``*see :func:`foo`*`` is not
|
496
|
-
possible.
|
497
|
-
|
498
|
-
|
499
|
-
.. rubric:: Footnotes
|
500
|
-
|
501
|
-
.. [1] When the default domain contains a :rst:dir:`class` directive, this directive
|
502
|
-
will be shadowed. Therefore, Sphinx re-exports it as :rst:dir:`rst-class`.
|
503
|
-
</textarea></form>
|
504
|
-
|
505
|
-
<script>
|
506
|
-
var editor = CodeMirror.fromTextArea(document.getElementById("code"), {
|
507
|
-
lineNumbers: true,
|
508
|
-
});
|
509
|
-
</script>
|
510
|
-
<p>The reStructuredText mode supports one configuration parameter:</p>
|
511
|
-
<dl>
|
512
|
-
<dt><code>verbatim (string)</code></dt>
|
513
|
-
<dd>A name or MIME type of a mode that will be used for highlighting
|
514
|
-
verbatim blocks. By default, reStructuredText mode uses uniform color
|
515
|
-
for whole block of verbatim text if no mode is given.</dd>
|
516
|
-
</dl>
|
517
|
-
<p>If <code>python</code> mode is available,
|
518
|
-
it will be used for highlighting blocks containing Python/IPython terminal
|
519
|
-
sessions (blocks starting with <code>>>></code> (for Python) or
|
520
|
-
<code>In [num]:</code> (for IPython).
|
521
|
-
|
522
|
-
<p><strong>MIME types defined:</strong> <code>text/x-rst</code>.</p>
|
523
|
-
</body>
|
524
|
-
</html>
|
525
|
-
|