diff --git a/doc/org-guide.org b/doc/org-guide.org index 8ad2d8eaa..95828e4c0 100644 --- a/doc/org-guide.org +++ b/doc/org-guide.org @@ -2223,8 +2223,8 @@ compatible with XHTML 1.0 strict standard. exports to =myfile.html=, overwriting without warning. {{{kbd(C-c C-e h o)}}} exports to HTML and opens it in a web browser. -The HTML export back-end transforms =<= and =>= to =<= and =>=. -To include raw HTML code in the Org file so the HTML export back-end +The HTML export backend transforms =<= and =>= to =<= and =>=. +To include raw HTML code in the Org file so the HTML export backend can insert that HTML code in the output, use this inline syntax: =@@html:...@@=. For example: @@ -2245,7 +2245,7 @@ For larger raw HTML code blocks, use these HTML export code blocks: :DESCRIPTION: Exporting to @LaTeX{} and processing to PDF. :END: -The LaTeX export back-end can handle complex documents, incorporate +The LaTeX export backend can handle complex documents, incorporate standard or custom LaTeX document classes, generate documents using alternate LaTeX engines, and produce fully linked PDF files with indexes, bibliographies, and tables of contents, destined for @@ -2269,7 +2269,7 @@ The class must be listed in ~org-latex-classes~. Export as LaTeX file and convert it to PDF, then open the PDF using the default viewer. -The LaTeX export back-end can insert any arbitrary LaTeX code, see +The LaTeX export backend can insert any arbitrary LaTeX code, see [[*Embedded LaTeX]]. There are three ways to embed such code in the Org file and they all use different quoting syntax. @@ -2281,7 +2281,7 @@ Inserting as one or more keyword lines in the Org file: : #+LATEX: any arbitrary LaTeX code -Inserting as an export block in the Org file, where the back-end +Inserting as an export block in the Org file, where the backend exports any code between begin and end markers: #+begin_example @@ -2297,7 +2297,7 @@ exports any code between begin and end markers: A large part of Org mode's interoperability success is its ability to easily export to or import from external applications. The iCalendar -export back-end takes calendar data from Org files and exports to the +export backend takes calendar data from Org files and exports to the standard iCalendar format. - {{{kbd(C-c C-e c f)}}} :: diff --git a/doc/org-manual.org b/doc/org-manual.org index 74edbe1d4..007126714 100644 --- a/doc/org-manual.org +++ b/doc/org-manual.org @@ -11103,7 +11103,7 @@ possible to provide your own special symbols in the variable ~org-entities-user~. During export, these symbols are transformed into the native format of -the exporter back-end. Strings like =\alpha= are exported as =α= in +the exporter backend. Strings like =\alpha= are exported as =α= in the HTML output, and as =\(\alpha\)= in the LaTeX output. Similarly, =\nbsp= becomes = = in HTML and =~= in LaTeX. @@ -11143,7 +11143,7 @@ symbols and the occasional formula. LaTeX[fn:36] is widely used to typeset scientific documents. Org mode supports embedding LaTeX code into its files, because many academics are used to writing and reading LaTeX source code, and because it can be readily processed to produce -pretty output for a number of export back-ends. +pretty output for a number of export backends. *** LaTeX fragments :PROPERTIES: @@ -11153,7 +11153,7 @@ pretty output for a number of export back-ends. #+vindex: org-format-latex-header Org mode can contain LaTeX math fragments, and it supports ways to -process these for several export back-ends. When exporting to LaTeX, +process these for several export backends. When exporting to LaTeX, the code is left as it is. When exporting to HTML, Org can use either [[https://www.mathjax.org][MathJax]] (see [[*Math formatting in HTML export]]) or transcode the math into images (see [[*Previewing LaTeX fragments]]). @@ -11189,7 +11189,7 @@ either $$ a=+\sqrt{2} $$ or \[ a=-\sqrt{2} \]. #+vindex: org-export-with-latex LaTeX processing can be configured with the variable ~org-export-with-latex~. The default setting is ~t~ which means -MathJax for HTML, and no processing for ASCII and LaTeX back-ends. +MathJax for HTML, and no processing for ASCII and LaTeX backends. You can also set this variable on a per-file basis using one of these lines: @@ -11570,7 +11570,7 @@ Optionally, the caption can take the form: Even though images and tables are prominent examples of captioned structures, the same caption mechanism can apply to many others---e.g., LaTeX equations, source code blocks. Depending on the -export back-end, those may or may not be handled. +export backend, those may or may not be handled. ** Horizontal Rules :PROPERTIES: @@ -11687,10 +11687,11 @@ export documents to a variety of other formats while retaining as much structure (see [[*Document Structure]]) and markup (see [[*Markup for Rich Contents]]) as possible. +#+cindex: export backend #+cindex: export back-end The libraries responsible for translating Org files to other formats -are called /back-ends/. Org ships with support for the following -back-ends: +are called /backends/. Org ships with support for the following +backends: - /ascii/ (ASCII format) - /beamer/ (LaTeX Beamer format) @@ -11706,15 +11707,15 @@ back-ends: Users can install libraries for additional formats from the Emacs packaging system. For easy discovery, these packages have a common naming scheme: ~ox-NAME~, where {{{var(NAME)}}} is a format. For -example, ~ox-koma-letter~ for /koma-letter/ back-end. More libraries +example, ~ox-koma-letter~ for /koma-letter/ backend. More libraries can be found in the =org-contrib= repository (see [[*Installation]]). #+vindex: org-export-backends -Org only loads back-ends for the following formats by default: ASCII, -HTML, iCalendar, LaTeX, and ODT. Additional back-ends can be loaded +Org only loads backends for the following formats by default: ASCII, +HTML, iCalendar, LaTeX, and ODT. Additional backends can be loaded in either of two ways: by configuring the ~org-export-backends~ variable, or by requiring libraries in the Emacs init file. For -example, to load the Markdown back-end, add this to your Emacs config: +example, to load the Markdown backend, add this to your Emacs config: #+begin_src emacs-lisp (require 'ox-md) @@ -11776,7 +11777,7 @@ further alter what is exported, and how. #+kindex: C-c C-e C-b Toggle body-only export. Useful for excluding headers and footers - in the export. Affects only those back-end formats that have + in the export. Affects only those backend formats that have sections like =...= in HTML. - {{{kbd(C-s)}}} :: @@ -11818,14 +11819,14 @@ set at a specific level override options set at a more general level. #+cindex: @samp{SETUPFILE}, keyword In-buffer settings may appear anywhere in the file, either directly or indirectly through a file included using =#+SETUPFILE: filename or -URL= syntax. Option keyword sets tailored to a particular back-end +URL= syntax. Option keyword sets tailored to a particular backend can be inserted from the export dispatcher (see [[*The Export Dispatcher]]) using the =Insert template= command by pressing {{{kbd(#)}}}. To insert keywords individually, a good way to make sure the keyword is correct is to type =#+= and then to use {{{kbd(M-TAB)}}}[fn:6] for completion. -The export keywords available for every back-end, and their equivalent +The export keywords available for every backend, and their equivalent global variables, include: - =AUTHOR= :: @@ -11897,7 +11898,7 @@ global variables, include: #+cindex: @samp{EXPORT_FILE_NAME}, keyword The name of the output file to be generated. Otherwise, Org generates the file name based on the buffer name and the extension - based on the back-end format. + based on the backend format. The =OPTIONS= keyword is a compact form. To configure multiple options, use several =OPTIONS= lines. =OPTIONS= recognizes the @@ -12010,7 +12011,7 @@ following arguments. #+vindex: org-export-headline-levels Set the number of headline levels for export (~org-export-headline-levels~). Below that level, headlines are - treated differently. In most back-ends, they become list items. + treated differently. In most backends, they become list items. - ~inline~ :: @@ -12323,7 +12324,7 @@ turns ={{{gnustamp(linux)}}}= into =GNU/Linux= during export. Org recognizes macro references in following Org markup areas: paragraphs, headlines, verse blocks, tables cells and lists. Org also recognizes macro references in keywords, such as =CAPTION=, =TITLE=, -=AUTHOR=, =DATE=, and for some back-end specific export options. +=AUTHOR=, =DATE=, and for some backend specific export options. Org comes with following pre-defined macros: @@ -12480,7 +12481,7 @@ See the variable ~org-ascii-links-to-notes~ for details. :UNNUMBERED: notoc :END: -The ASCII export back-end has one extra keyword for customizing ASCII +The ASCII export backend has one extra keyword for customizing ASCII output. Setting this keyword works similar to the general options (see [[*Export Settings]]). @@ -12505,7 +12506,7 @@ cut-off point where levels become lists, see [[*Export Settings]]. :UNNUMBERED: notoc :END: -To insert text within the Org file by the ASCII back-end, use one the +To insert text within the Org file by the ASCII backend, use one the following constructs, inline, keyword, or export block: #+cindex: @samp{ASCII}, keyword @@ -12516,7 +12517,7 @@ Inline text @@ascii:and additional text@@ within a paragraph. ,#+ASCII: Some text ,#+BEGIN_EXPORT ascii -Org exports text in this block only when using ASCII back-end. +Org exports text in this block only when using ASCII backend. ,#+END_EXPORT #+end_example @@ -12527,7 +12528,7 @@ Org exports text in this block only when using ASCII back-end. #+cindex: @samp{ATTR_ASCII}, keyword #+cindex: horizontal rules, in ASCII export -ASCII back-end recognizes only one attribute, =:width=, which +ASCII backend recognizes only one attribute, =:width=, which specifies the width of a horizontal rule in number of characters. The keyword and syntax for specifying widths is: @@ -12544,7 +12545,7 @@ keyword and syntax for specifying widths is: #+cindex: @samp{BEGIN_JUSTIFYLEFT} #+cindex: @samp{BEGIN_JUSTIFYRIGHT} -Besides =#+BEGIN_CENTER= blocks (see [[*Paragraphs]]), ASCII back-end has +Besides =#+BEGIN_CENTER= blocks (see [[*Paragraphs]]), ASCII backend has these two left and right justification blocks: #+begin_example @@ -12603,7 +12604,7 @@ popular display formats. :DESCRIPTION: For customizing Beamer export. :END: -Beamer export back-end has several additional keywords for customizing +Beamer export backend has several additional keywords for customizing Beamer output. These keywords work similar to the general options settings (see [[*Export Settings]]). @@ -12716,7 +12717,7 @@ should in principle be exportable as a Beamer presentation. headline as an overlay or action specification. When enclosed in square brackets, Org export makes the overlay specification a default. Use =BEAMER_OPT= to set any options applicable to the - current Beamer frame or block. The Beamer export back-end wraps + current Beamer frame or block. The Beamer export backend wraps with appropriate angular or square brackets. It also adds the =fragile= option for any code that may require a verbatim block. @@ -12738,8 +12739,8 @@ should in principle be exportable as a Beamer presentation. :DESCRIPTION: For using in Org documents. :END: -Since Org's Beamer export back-end is an extension of the LaTeX -back-end, it recognizes other LaTeX specific syntax---for example, +Since Org's Beamer export backend is an extension of the LaTeX +backend, it recognizes other LaTeX specific syntax---for example, =#+LATEX:= or =#+ATTR_LATEX:=. See [[*LaTeX Export]], for details. Beamer export wraps the table of contents generated with =toc:t= @@ -12757,7 +12758,7 @@ Insert Beamer-specific code using the following constructs: ,#+BEAMER: \pause ,#+BEGIN_EXPORT beamer - Only Beamer export back-end exports this. + Only Beamer export backend exports this. ,#+END_EXPORT Text @@beamer:some code@@ within a paragraph. @@ -13094,8 +13095,8 @@ name, and date. :DESCRIPTION: Using direct HTML in Org files. :END: -The HTML export back-end transforms =<= and =>= to =<= and =>=. -To include raw HTML code in the Org file so the HTML export back-end +The HTML export backend transforms =<= and =>= to =<= and =>=. +To include raw HTML code in the Org file so the HTML export backend can insert that HTML code in the output, use this inline syntax: =@@html:...@@=. For example: @@ -13136,25 +13137,25 @@ a =href= attribute making the headlines link to themselves. #+cindex: internal links, in HTML export #+cindex: external links, in HTML export -The HTML export back-end transforms Org's internal links (see -[[*Internal Links]]) to equivalent HTML links in the output. The back-end +The HTML export backend transforms Org's internal links (see +[[*Internal Links]]) to equivalent HTML links in the output. The backend similarly handles Org's automatic links created by radio targets (see [[*Radio Targets]]) similarly. For Org links to external files, the -back-end transforms the links to /relative/ paths. +backend transforms the links to /relative/ paths. #+vindex: org-html-link-org-files-as-html -For Org links to other =.org= files, the back-end automatically +For Org links to other =.org= files, the backend automatically changes the file extension to =.html= and makes file paths relative. If the =.org= files have an equivalent =.html= version at the same location, then the converted links should work without any further manual intervention. However, to disable this automatic path translation, set ~org-html-link-org-files-as-html~ to ~nil~. When -disabled, the HTML export back-end substitutes the ID-based links in +disabled, the HTML export backend substitutes the ID-based links in the HTML output. For more about linking files when publishing to a directory, see [[*Publishing links]]. Org files can also have special directives to the HTML export -back-end. For example, by using =#+ATTR_HTML= lines to specify new +backend. For example, by using =#+ATTR_HTML= lines to specify new format attributes to ~~ or ~~ tags. This example shows changing the link's title and style: @@ -13171,7 +13172,7 @@ changing the link's title and style: #+cindex: tables, in HTML #+vindex: org-export-html-table-tag -The HTML export back-end uses ~org-html-table-default-attributes~ when +The HTML export backend uses ~org-html-table-default-attributes~ when exporting Org tables to HTML. By default, the exporter does not draw frames and cell borders. To change for this for a table, use the following lines before the table in the Org file: @@ -13183,7 +13184,7 @@ following lines before the table in the Org file: ,#+ATTR_HTML: :border 2 :rules all :frame border #+end_example -The HTML export back-end preserves column groupings in Org tables (see +The HTML export backend preserves column groupings in Org tables (see [[*Column Groups]]) when exporting to HTML. Additional options for customizing tables for HTML export. @@ -13231,20 +13232,20 @@ Additional options for customizing tables for HTML export. #+cindex: images, inline in HTML #+cindex: inlining images in HTML -The HTML export back-end has features to convert Org image links to +The HTML export backend has features to convert Org image links to HTML inline images and HTML clickable image links. #+vindex: org-html-inline-images When the link in the Org file has no description, the HTML export -back-end by default in-lines that image. For example: +backend by default in-lines that image. For example: =[[file:myimg.jpg]]= is in-lined, while =[[file:myimg.jpg][the image]]= links to the text, =the image=. For more details, see the variable ~org-html-inline-images~. On the other hand, if the description part of the Org link is itself another link, such as =file:= or =http:= URL pointing to an image, the -HTML export back-end in-lines this image and links to the main image. -This Org syntax enables the back-end to link low-resolution thumbnail +HTML export backend in-lines this image and links to the main image. +This Org syntax enables the backend to link low-resolution thumbnail to the high-resolution version of the image, as shown in this example: : [[file:highres.jpg][file:thumb.jpg]] @@ -13262,7 +13263,7 @@ accessibility standards. [[./img/a.jpg]] #+end_example -The HTML export back-end copies the =http= links from the Org file +The HTML export backend copies the =http= links from the Org file as-is. *** Math formatting in HTML export @@ -13325,12 +13326,12 @@ HTML was by using =:textarea=. The advantage of this approach was that copying and pasting was built into browsers with simple JavaScript commands. Even editing before pasting was made simple. -The HTML export back-end can create such text areas. It requires an +The HTML export backend can create such text areas. It requires an =#+ATTR_HTML= line as shown in the example below with the =:textarea= option. This must be followed by either an example or a source code block. Other Org block types do not honor the =:textarea= option. -By default, the HTML export back-end creates a text area 80 characters +By default, the HTML export backend creates a text area 80 characters wide and height just enough to fit the content. Override these defaults with =:width= and =:height= options on the =#+ATTR_HTML= line. @@ -13397,7 +13398,7 @@ classes like for headlines, tables, etc. #+vindex: org-html-head #+vindex: org-html-head-extra #+cindex: @samp{HTML_INCLUDE_STYLE}, keyword -The HTML export back-end includes a compact default style in each +The HTML export backend includes a compact default style in each exported HTML file. To override the default style with another style, use these keywords in the Org file. They will replace the global defaults the HTML exporter uses. @@ -13526,7 +13527,7 @@ to your pages, configure the variable ~org-export-html-use-infojs~. #+cindex: @LaTeX{} export #+cindex: PDF export -The LaTeX export back-end can handle complex documents, incorporate +The LaTeX export backend can handle complex documents, incorporate standard or custom LaTeX document classes, generate documents using alternate LaTeX engines, and produce fully linked PDF files with indexes, bibliographies, and tables of contents, destined for @@ -13538,7 +13539,7 @@ quick references to variables for the impatient: for engines, see ~org-latex-pdf-process~; for packages, see ~org-latex-default-packages-alist~ and ~org-latex-packages-alist~. -An important note about the LaTeX export back-end: it is sensitive to +An important note about the LaTeX export backend: it is sensitive to blank lines in the Org document. That's because LaTeX itself depends on blank lines to tell apart syntactical elements, such as paragraphs. @@ -13585,10 +13586,10 @@ on blank lines to tell apart syntactical elements, such as paragraphs. #+cindex: xelatex #+cindex: lualatex #+cindex: @samp{LATEX_COMPILER}, keyword -The LaTeX export back-end can use any of these LaTeX engines: +The LaTeX export backend can use any of these LaTeX engines: =pdflatex=, =xelatex=, and =lualatex=. These engines compile LaTeX files with different compilers, packages, and output options. The -LaTeX export back-end finds the compiler version to use from +LaTeX export backend finds the compiler version to use from ~org-latex-compiler~ variable or the =#+LATEX_COMPILER= keyword in the Org file. See the docstring for the ~org-latex-default-packages-alist~ for loading packages with certain @@ -13597,10 +13598,10 @@ bibliography compiler[fn:47]. *** LaTeX specific export settings :PROPERTIES: -:DESCRIPTION: Unique to this @LaTeX{} back-end. +:DESCRIPTION: Unique to this @LaTeX{} backend. :END: -The LaTeX export back-end has several additional keywords for +The LaTeX export backend has several additional keywords for customizing LaTeX output. Setting these keywords works similar to the general options (see [[*Export Settings]]). @@ -13647,7 +13648,7 @@ general options (see [[*Export Settings]]). #+vindex: org-latex-classes This is LaTeX document class, such as /article/, /report/, /book/, and so on, which contain predefined preamble and headline level - mapping that the LaTeX export back-end needs. The back-end reads + mapping that the LaTeX export backend needs. The backend reads the default class name from the ~org-latex-default-class~ variable. Org has /article/ as the default class. A valid default class must be an element of ~org-latex-classes~. @@ -13655,7 +13656,7 @@ general options (see [[*Export Settings]]). - =LATEX_CLASS_OPTIONS= :: #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword - Options the LaTeX export back-end uses when calling the LaTeX + Options the LaTeX export backend uses when calling the LaTeX document class. - =LATEX_COMPILER= :: @@ -13711,12 +13712,12 @@ The following sections have further details. #+cindex: header, for @LaTeX{} files #+cindex: sectioning structure, for @LaTeX{} export -The LaTeX export back-end converts the first three of Org's outline +The LaTeX export backend converts the first three of Org's outline levels into LaTeX headlines. The remaining Org levels are exported as lists. To change this globally for the cut-off point between levels and lists, (see [[*Export Settings]]). -By default, the LaTeX export back-end uses the /article/ class. +By default, the LaTeX export backend uses the /article/ class. #+vindex: org-latex-default-class #+vindex: org-latex-classes @@ -13736,7 +13737,7 @@ custom sectioning or custom classes. #+cindex: @samp{LATEX_CLASS_OPTIONS}, keyword #+cindex: @samp{EXPORT_LATEX_CLASS}, property #+cindex: @samp{EXPORT_LATEX_CLASS_OPTIONS}, property -The LaTeX export back-end sends the =LATEX_CLASS_OPTIONS= keyword and +The LaTeX export backend sends the =LATEX_CLASS_OPTIONS= keyword and =EXPORT_LATEX_CLASS_OPTIONS= property as options to the LaTeX ~\documentclass~ macro. The options and the syntax for specifying them, including enclosing them in square brackets, follow LaTeX @@ -13746,10 +13747,10 @@ conventions. #+cindex: @samp{LATEX_HEADER}, keyword #+cindex: @samp{LATEX_HEADER_EXTRA}, keyword -The LaTeX export back-end appends values from =LATEX_HEADER= and +The LaTeX export backend appends values from =LATEX_HEADER= and =LATEX_HEADER_EXTRA= keywords to the LaTeX header. The docstring for ~org-latex-classes~ explains in more detail. Also note that LaTeX -export back-end does not append =LATEX_HEADER_EXTRA= to the header +export backend does not append =LATEX_HEADER_EXTRA= to the header when previewing LaTeX snippets (see [[*Previewing LaTeX fragments]]). A sample Org file with the above headers: @@ -13818,7 +13819,7 @@ This would produce in LaTeX (with the actual =polyglossia= syntax): :DESCRIPTION: Incorporating literal @LaTeX{} code. :END: -The LaTeX export back-end can insert any arbitrary LaTeX code, see +The LaTeX export backend can insert any arbitrary LaTeX code, see [[*Embedded LaTeX]]. There are three ways to embed such code in the Org file and they all use different quoting syntax. @@ -13833,7 +13834,7 @@ Inserting as one or more keyword lines in the Org file: : #+LATEX: any arbitrary LaTeX code #+cindex: @samp{BEGIN_EXPORT latex} -Inserting as an export block in the Org file, where the back-end +Inserting as an export block in the Org file, where the backend exports any code between begin and end markers: #+begin_example @@ -13848,7 +13849,7 @@ exports any code between begin and end markers: :END: #+cindex: tables, in @LaTeX{} export -The LaTeX export back-end can pass several LaTeX attributes for table +The LaTeX export backend can pass several LaTeX attributes for table contents and layout. Besides specifying a label (see [[*Internal Links]]) and a caption (see [[*Captions]]), the other valid LaTeX attributes include: @@ -13857,27 +13858,27 @@ include: - =:mode= :: #+vindex: org-latex-default-table-mode - The LaTeX export back-end wraps the table differently depending on + The LaTeX export backend wraps the table differently depending on the mode for accurate rendering of math symbols. Mode is either =table=, =math=, =inline-math=, =verbatim= or =tabbing=. - For =math= or =inline-math= mode, LaTeX export back-end wraps the + For =math= or =inline-math= mode, LaTeX export backend wraps the table in a math environment, but every cell in it is exported as-is. For =tabbing= the LaTeX tabbing environment is used and the correct tabbing delimiters =\>= are used. - The LaTeX export back-end determines the default mode from - ~org-latex-default-table-mode~. The LaTeX export back-end merges + The LaTeX export backend determines the default mode from + ~org-latex-default-table-mode~. The LaTeX export backend merges contiguous tables in the same mode into a single environment. - =:environment= :: #+vindex: org-latex-default-table-environment Set the default LaTeX table environment for the LaTeX export - back-end to use when exporting Org tables. Common LaTeX table + backend to use when exporting Org tables. Common LaTeX table environments are provided by these packages: tabularx, longtable, array, tabu, and bmatrix. For packages, such as tabularx and tabu, or any newer replacements, include them in the - ~org-latex-packages-alist~ variable so the LaTeX export back-end can + ~org-latex-packages-alist~ variable so the LaTeX export backend can insert the appropriate load package headers in the converted LaTeX file. Look in the docstring for the ~org-latex-packages-alist~ variable for configuring these packages for LaTeX snippet previews, @@ -13903,11 +13904,11 @@ include: LaTeX floats can also have additional layout =:placement= attributes. These are the usual =[h t b p ! H]= permissions specified in square brackets. Note that for =:float sideways= - tables, the LaTeX export back-end ignores =:placement= attributes. + tables, the LaTeX export backend ignores =:placement= attributes. - =:align=, =:font=, =:width= :: - The LaTeX export back-end uses these attributes for regular tables + The LaTeX export backend uses these attributes for regular tables to set their alignments, fonts, and widths. - =:options= :: @@ -13920,7 +13921,7 @@ include: - =:spread= :: - When =:spread= is non-~nil~, the LaTeX export back-end spreads or + When =:spread= is non-~nil~, the LaTeX export backend spreads or shrinks the table by the =:width= for tabu and longtabu environments. =:spread= has no effect if =:width= is not set. @@ -13937,10 +13938,10 @@ include: - =:math-prefix=, =:math-suffix=, =:math-arguments= :: - The LaTeX export back-end inserts =:math-prefix= string value in - a math environment before the table. The LaTeX export back-end + The LaTeX export backend inserts =:math-prefix= string value in + a math environment before the table. The LaTeX export backend inserts =:math-suffix= string value in a math environment after the - table. The LaTeX export back-end inserts =:math-arguments= string + table. The LaTeX export backend inserts =:math-arguments= string value between the macro name and the table's contents. =:math-arguments= comes in use for matrix macros that require more than one argument, such as =qbordermatrix=. @@ -13978,13 +13979,13 @@ Set the caption with the LaTeX command #+cindex: inlining images in LaTeX #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end processes image links in Org files that do +The LaTeX export backend processes image links in Org files that do not have descriptions, such as these links =[[file:img.jpg]]= or =[[./img.jpg]]=, as direct image insertions in the final PDF output. In the PDF, they are no longer links but actual images embedded on the -page. The LaTeX export back-end uses =\includegraphics= macro to +page. The LaTeX export backend uses =\includegraphics= macro to insert the image. But for TikZ (https://sourceforge.net/projects/pgf/) -images, the back-end uses an ~\input~ macro wrapped within +images, the backend uses an ~\input~ macro wrapped within a ~tikzpicture~ environment. For specifying image =:width=, =:height=, =:scale= and other =:options=, @@ -14006,7 +14007,7 @@ overrides the default =#+CAPTION= value: #+end_example When captions follow the method as described in [[*Captions]], the LaTeX -export back-end wraps the picture in a floating =figure= environment. +export backend wraps the picture in a floating =figure= environment. To float an image without specifying a caption, set the =:float= attribute to one of the following: @@ -14016,7 +14017,7 @@ attribute to one of the following: - =multicolumn= :: - To span the image across multiple columns of a page; the back-end + To span the image across multiple columns of a page; the backend wraps the image in a =figure*= environment. - =wrap= :: @@ -14050,12 +14051,12 @@ placement. #+vindex: org-latex-images-centered #+cindex: center image in LaTeX export #+cindex: image, centering in LaTeX export -The LaTeX export back-end centers all images by default. Setting +The LaTeX export backend centers all images by default. Setting =:center= to =nil= disables centering. To disable centering globally, set ~org-latex-images-centered~ to =nil=. Set the =:comment-include= attribute to non-~nil~ value for the LaTeX -export back-end to comment out the =\includegraphics= macro. +export backend to comment out the =\includegraphics= macro. *** Plain lists in LaTeX export :PROPERTIES: @@ -14064,7 +14065,7 @@ export back-end to comment out the =\includegraphics= macro. #+cindex: plain lists, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end accepts the =environment= and =options= +The LaTeX export backend accepts the =environment= and =options= attributes for plain lists. Both attributes work together for customizing lists, as shown in the examples: @@ -14100,7 +14101,7 @@ four: #+cindex: source blocks, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end can make source code blocks into floating +The LaTeX export backend can make source code blocks into floating objects through the attributes =:float= and =:options=. For =:float=: - =t= :: @@ -14127,7 +14128,7 @@ objects through the attributes =:float= and =:options=. For =:float=: #+vindex: org-latex-listings-options #+vindex: org-latex-minted-options #+vindex: org-latex-engraved-options -The LaTeX export back-end passes string values in =:options= to LaTeX +The LaTeX export backend passes string values in =:options= to LaTeX packages for customization of that specific source block. In the example below, the =:options= are set for Engraved or Minted. Minted is a source code highlighting LaTeX package with many configurable @@ -14158,7 +14159,7 @@ variables. #+cindex: verbatim blocks, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end wraps the contents of example blocks in +The LaTeX export backend wraps the contents of example blocks in a =verbatim= environment. To change this behavior to use another environment globally, specify an appropriate export filter (see [[*Advanced Export Configuration]]). To change this behavior to use @@ -14182,8 +14183,8 @@ to specify a custom environment. #+cindex: proof, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -For other special blocks in the Org file, the LaTeX export back-end -makes a special environment of the same name. The back-end also takes +For other special blocks in the Org file, the LaTeX export backend +makes a special environment of the same name. The backend also takes =:options=, if any, and appends as-is to that environment's opening string. For example: @@ -14231,7 +14232,7 @@ example: #+cindex: horizontal rules, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end converts horizontal rules by the specified +The LaTeX export backend converts horizontal rules by the specified =:width= and =:thickness= attributes. For example: #+begin_example @@ -14247,7 +14248,7 @@ The LaTeX export back-end converts horizontal rules by the specified #+cindex: verse blocks, in @LaTeX{} export #+cindex: @samp{ATTR_LATEX}, keyword -The LaTeX export back-end accepts four attributes for verse blocks: +The LaTeX export backend accepts four attributes for verse blocks: =:lines=, =:center=, =:versewidth= and =:latexcode=. The three first require the external LaTeX package =verse.sty=, which is an extension of the standard LaTeX environment. @@ -14295,7 +14296,7 @@ To eat the world’s due, by the grave and thee. #+cindex: @samp{ATTR_LATEX}, keyword #+cindex: org-latex-default-quote-environment -The LaTeX export back-end accepts two attributes for quote blocks: +The LaTeX export backend accepts two attributes for quote blocks: =:environment=, for an arbitrary quoting environment (the default value is that of ~org-latex-default-quote-environment~: ~"quote"~) and =:options=. For example, to choose the environment =quotation=, @@ -14334,12 +14335,12 @@ some text in German... :END: #+cindex: Markdown export -The Markdown export back-end, "md", converts an Org file to Markdown +The Markdown export backend, "md", converts an Org file to Markdown format, as defined at https://daringfireball.net/projects/markdown/. This is the original Markdown specification, developed by John Gruber and Aaron Swartz. -Since "md" back-end is built on top of the HTML back-end (see [[*HTML +Since "md" backend is built on top of the HTML backend (see [[*HTML Export]]), it converts every Org construct not defined in Markdown syntax, such as tables, to HTML. @@ -14379,7 +14380,7 @@ https://en.wikipedia.org/wiki/Markdown for more details. Based on ~org-md-headline-style~, Markdown export can generate headlines of both /atx/ and /setext/ types. /atx/ limits headline levels to two whereas /setext/ limits headline levels to six. Beyond -these limits, the export back-end converts headlines to lists. To set +these limits, the export backend converts headlines to lists. To set a limit to a level before the absolute limit (see [[*Export Settings]]). ** OpenDocument Text Export @@ -14391,7 +14392,7 @@ a limit to a level before the absolute limit (see [[*Export Settings]]). #+cindex: export, OpenDocument #+cindex: LibreOffice -The ODT export back-end handles creating of OpenDocument Text (ODT) +The ODT export backend handles creating of OpenDocument Text (ODT) format. Documents created by this exporter use the {{{cite(OpenDocument-v1.2 specification)}}}[fn:: See [[https://docs.oasis-open.org/office/v1.2/OpenDocument-v1.2.html][Open @@ -14404,7 +14405,7 @@ and are compatible with LibreOffice 3.4. :END: #+cindex: zip -The ODT export back-end relies on the zip program to create the final +The ODT export backend relies on the zip program to create the final compressed ODT output. Check if =zip= is locally available and executable. Without it, export cannot finish. @@ -14423,16 +14424,16 @@ executable. Without it, export cannot finish. #+vindex: org-odt-preferred-output-format If ~org-odt-preferred-output-format~ is specified, the ODT export - back-end automatically converts the exported file to that format. + backend automatically converts the exported file to that format. For =myfile.org=, Org exports to =myfile.odt=, overwriting without - warning. The ODT export back-end exports a region only if a region + warning. The ODT export backend exports a region only if a region was active. - If the selected region is a single tree, the ODT export back-end + If the selected region is a single tree, the ODT export backend makes the tree head the document title. Incidentally, {{{kbd(C-c @)}}} selects the current subtree. If the tree head entry has, or - inherits, an =EXPORT_FILE_NAME= property, the ODT export back-end + inherits, an =EXPORT_FILE_NAME= property, the ODT export backend uses that for file name. - {{{kbd(C-c C-e o O)}}} :: @@ -14450,21 +14451,21 @@ executable. Without it, export cannot finish. :DESCRIPTION: Configuration options. :END: -The ODT export back-end has several additional keywords for +The ODT export backend has several additional keywords for customizing ODT output. Setting these keywords works similar to the general options (see [[*Export Settings]]). - =DESCRIPTION= :: #+cindex: @samp{DESCRIPTION}, keyword - This is the document's description, which the ODT export back-end + This is the document's description, which the ODT export backend inserts as document metadata. For long descriptions, use multiple lines, prefixed with =DESCRIPTION=. - =KEYWORDS= :: #+cindex: @samp{KEYWORDS}, keyword - The keywords for the document. The ODT export back-end inserts the + The keywords for the document. The ODT export backend inserts the description along with author name, keywords, and related file metadata as metadata in the output file. Use multiple =KEYWORDS= if necessary. @@ -14473,7 +14474,7 @@ general options (see [[*Export Settings]]). #+cindex: @samp{ODT_STYLES_FILE}, keyword #+vindex: org-odt-styles-file - The ODT export back-end uses the ~org-odt-styles-file~ by default. + The ODT export backend uses the ~org-odt-styles-file~ by default. See [[*Applying custom styles]] for details. - =SUBTITLE= :: @@ -14486,7 +14487,7 @@ general options (see [[*Export Settings]]). :DESCRIPTION: Producing DOC, PDF files. :END: -The ODT export back-end can produce documents in other formats besides +The ODT export backend can produce documents in other formats besides ODT using a specialized ODT converter process. Its common interface works with popular converters to produce formats such as =doc=, or convert a document from one format, say =csv=, to another format, say @@ -14508,7 +14509,7 @@ a document converter]]. #+vindex: org-odt-preferred-output-format If ODT format is just an intermediate step to get to other formats, such as =doc=, =docx=, =rtf=, or =pdf=, etc., then extend the ODT -export back-end to directly produce that format. Specify the final +export backend to directly produce that format. Specify the final format in the ~org-odt-preferred-output-format~ variable. This is one way to extend (see [[*ODT export commands]]). @@ -14517,7 +14518,7 @@ way to extend (see [[*ODT export commands]]). :UNNUMBERED: notoc :END: -The Org export back-end is made to be inter-operable with a wide range +The Org export backend is made to be inter-operable with a wide range of text document format converters. Newer generation converters, such as LibreOffice and Pandoc, can handle hundreds of formats at once. Org provides a consistent interaction with whatever converter is @@ -14536,7 +14537,7 @@ installed. Here are some generic commands: #+cindex: styles, custom #+cindex: template, custom -The ODT export back-end comes with many OpenDocument styles (see +The ODT export backend comes with many OpenDocument styles (see [[*Working with OpenDocument style files]]). To expand or further customize these built-in style sheets, either edit the style sheets directly or generate them using an application such as LibreOffice. @@ -14579,7 +14580,7 @@ The example here shows creating a style using LibreOffice. :UNNUMBERED: notoc :END: -The ODT export back-end relies on many templates and style names. +The ODT export backend relies on many templates and style names. Using third-party styles and templates can lead to mismatches. Templates derived from built-in ODT templates and styles seem to have fewer problems. @@ -14608,18 +14609,18 @@ with a cross-reference and sequence number of the labeled entity. See #+cindex: tables, in ODT export -The ODT export back-end handles native Org mode tables (see [[*Tables]]) +The ODT export backend handles native Org mode tables (see [[*Tables]]) and simple =table.el= tables. Complex =table.el= tables having column or row spans are not supported. Such tables are stripped from the exported document. -By default, the ODT export back-end exports a table with top and +By default, the ODT export backend exports a table with top and bottom frames and with ruled lines separating row and column groups (see [[*Column Groups]]). All tables are typeset to occupy the same -width. The ODT export back-end honors any table alignments and +width. The ODT export backend honors any table alignments and relative widths for columns (see [[*Column Width and Alignment]]). -Note that the ODT export back-end interprets column widths as weighted +Note that the ODT export backend interprets column widths as weighted ratios, the default weight being 1. #+cindex: @samp{ATTR_ODT}, keyword @@ -14661,7 +14662,7 @@ tables in ODT export]]. :UNNUMBERED: notoc :END: -The ODT export back-end processes image links in Org files that do not +The ODT export backend processes image links in Org files that do not have descriptions, such as these links =[[file:img.jpg]]= or =[[./img.jpg]]=, as direct image insertions in the final output. Either of these examples works: @@ -14694,13 +14695,13 @@ attribute. #+cindex: identify, ImageMagick #+vindex: org-odt-pixels-per-inch -The ODT export back-end starts with establishing the size of the image +The ODT export backend starts with establishing the size of the image in the final document. The dimensions of this size are measured in -centimeters. The back-end then queries the image file for its -dimensions measured in pixels. For this measurement, the back-end +centimeters. The backend then queries the image file for its +dimensions measured in pixels. For this measurement, the backend relies on ImageMagick's identify program or Emacs ~create-image~ and ~image-size~ API. ImageMagick is the preferred choice for large file -sizes or frequent batch operations. The back-end then converts the +sizes or frequent batch operations. The backend then converts the pixel dimensions using ~org-odt-pixels-per-inch~ into the familiar 72 dpi or 96 dpi. The default value for this is in ~display-pixels-per-inch~, which can be tweaked for better results @@ -14751,7 +14752,7 @@ image scaling operations: :END: #+cindex: @samp{ATTR_ODT}, keyword -The ODT export back-end can anchor images to =as-char=, =paragraph=, +The ODT export backend can anchor images to =as-char=, =paragraph=, or =page=. Set the preferred anchor using the =:anchor= property of the =ATTR_ODT= line. @@ -14912,9 +14913,9 @@ With the above modification, the previous example changes to: :DESCRIPTION: For source code and example blocks. :END: -The ODT export back-end supports literal examples (see [[*Literal +The ODT export backend supports literal examples (see [[*Literal Examples]]) with full fontification. Internally, the ODT export -back-end relies on =htmlfontify.el= to generate the style definitions +backend relies on =htmlfontify.el= to generate the style definitions needed for fancy listings. The auto-generated styles get =OrgSrc= prefix and inherit colors from the faces used by Emacs Font Lock library for that source language. @@ -14932,7 +14933,7 @@ To turn off fontification of literal examples, customize the :DESCRIPTION: For power users. :END: -The ODT export back-end has extensive features useful for power users +The ODT export backend has extensive features useful for power users and frequent uses of ODT formats. **** Configuring a document converter @@ -14944,7 +14945,7 @@ and frequent uses of ODT formats. #+cindex: doc, docx, rtf #+cindex: converter -The ODT export back-end works with popular converters with little or +The ODT export backend works with popular converters with little or no extra configuration. See [[*Extending ODT export]]. The following is for unsupported converters or tweaking existing defaults. @@ -15018,7 +15019,7 @@ factory styles used by the exporter. - ~org-odt-styles-file~ :: - The ODT export back-end uses the file pointed to by this variable, + The ODT export backend uses the file pointed to by this variable, such as =styles.xml=, for the final output. It can take one of the following values: @@ -15055,7 +15056,7 @@ factory styles used by the exporter. :UNNUMBERED: notoc :END: -The ODT export back-end can read embedded raw OpenDocument XML from +The ODT export backend can read embedded raw OpenDocument XML from the Org file. Such direct formatting is useful for one-off instances. - Embedding ODT tags as part of regular text :: @@ -15081,7 +15082,7 @@ the Org file. Such direct formatting is useful for one-off instances. - Embedding a one-line OpenDocument XML :: #+cindex: @samp{ODT}, keyword - The ODT export back-end can read one-liner options with =#+ODT:= in + The ODT export backend can read one-liner options with =#+ODT:= in the Org file. For example, to force a page break: #+begin_example @@ -15101,7 +15102,7 @@ the Org file. Such direct formatting is useful for one-off instances. - Embedding a block of OpenDocument XML :: - The ODT export back-end can also read ODT export blocks for + The ODT export backend can also read ODT export blocks for OpenDocument XML. Such blocks use the =#+BEGIN_EXPORT odt= ... =#+END_EXPORT= constructs. @@ -15265,7 +15266,7 @@ schema-sensitive editing---of XML files: [[info:nxml-mode::Introduction]]. #+vindex: org-export-odt-schema-dir Customize ~org-odt-schema-dir~ to point to a directory with OpenDocument RNC files and the needed schema-locating rules. The ODT -export back-end takes care of updating the +export backend takes care of updating the ~rng-schema-locating-files~. ** Org Export @@ -15274,9 +15275,9 @@ export back-end takes care of updating the :END: #+cindex: Org export -/org/ export back-end creates a normalized version of the Org document +/org/ export backend creates a normalized version of the Org document in current buffer. The exporter evaluates Babel code (see [[*Evaluating -Code Blocks]]) and removes content specific to other back-ends. +Code Blocks]]) and removes content specific to other backends. *** Org export commands :PROPERTIES: @@ -15326,7 +15327,7 @@ Code Blocks]]) and removes content specific to other back-ends. :DESCRIPTION: Setting the environment. :END: -The Texinfo export back-end has several additional keywords for +The Texinfo export backend has several additional keywords for customizing Texinfo output. Setting these keywords works similar to the general options (see [[*Export Settings]]). @@ -15388,7 +15389,7 @@ the general options (see [[*Export Settings]]). :END: #+cindex: @samp{TEXINFO_FILENAME}, keyword -After creating the header for a Texinfo file, the Texinfo back-end +After creating the header for a Texinfo file, the Texinfo backend automatically generates a name and destination path for the Info file. To override this default with a more sensible path and name, specify the =TEXINFO_FILENAME= keyword. @@ -15432,7 +15433,7 @@ keywords. They have to be set in raw Texinfo code. #+cindex: @samp{COPYING}, property Copying material is defined in a dedicated headline with a non-~nil~ -=COPYING= property. The back-end inserts the contents within +=COPYING= property. The backend inserts the contents within a =@copying= command at the beginning of the document. The heading itself does not appear in the structure of the document. @@ -15483,7 +15484,7 @@ Here is an example that writes to the Info directory file: #+vindex: org-texinfo-classes #+vindex: org-texinfo-default-class #+cindex: @samp{TEXINFO_CLASS}, keyword -The Texinfo export back-end uses a pre-defined scheme to convert Org +The Texinfo export backend uses a pre-defined scheme to convert Org headlines to equivalent Texinfo structuring commands. A scheme like this maps top-level headlines to numbered chapters tagged as ~@chapter~ and lower-level headlines to unnumbered chapters tagged as @@ -15491,21 +15492,21 @@ this maps top-level headlines to numbered chapters tagged as other Texinfo structuring commands, define a new class in ~org-texinfo-classes~. Activate the new class with the =TEXINFO_CLASS= keyword. When no new class is defined and activated, -the Texinfo export back-end defaults to the +the Texinfo export backend defaults to the ~org-texinfo-default-class~. If an Org headline's level has no associated Texinfo structuring command, or is below a certain threshold (see [[*Export Settings]]), then -the Texinfo export back-end makes it into a list item. +the Texinfo export backend makes it into a list item. #+cindex: @samp{APPENDIX}, property -The Texinfo export back-end makes any headline with a non-~nil~ +The Texinfo export backend makes any headline with a non-~nil~ =APPENDIX= property into an appendix. This happens independent of the Org headline level or the =TEXINFO_CLASS= keyword. #+cindex: @samp{ALT_TITLE}, property #+cindex: @samp{DESCRIPTION}, property -The Texinfo export back-end creates a menu entry after the Org +The Texinfo export backend creates a menu entry after the Org headline for each regular sectioning structure. To override this with a shorter menu entry, use the =ALT_TITLE= property (see [[*Table of Contents]]). Texinfo menu entries also have an option for a longer @@ -15543,7 +15544,7 @@ file. See [[info:texinfo::The Top Node]], for more information. #+cindex: data type index, in Texinfo export #+cindex: @samp{VINDEX}, keyword #+cindex: variable index, in Texinfo export -The Texinfo export back-end recognizes these indexing keywords if used +The Texinfo export backend recognizes these indexing keywords if used in the Org file: =CINDEX=, =FINDEX=, =KINDEX=, =PINDEX=, =TINDEX= and =VINDEX=. Write their value as verbatim Texinfo code; in particular, ={=, =}= and =@= characters need to be escaped with =@= if they do not @@ -15552,10 +15553,10 @@ belong to a Texinfo command. : #+CINDEX: Defining indexing entries #+cindex: @samp{INDEX}, property -For the back-end to generate an index entry for a headline, set the +For the backend to generate an index entry for a headline, set the =INDEX= property to =cp= or =vr=. These abbreviations come from Texinfo that stand for concept index and variable index. The Texinfo -manual has abbreviations for all other kinds of indexes. The back-end +manual has abbreviations for all other kinds of indexes. The backend exports the headline as an unnumbered chapter or section command, and then inserts the index after its contents. @@ -15595,7 +15596,7 @@ This paragraph is preceded by... #+cindex: lettered lists, in Texinfo export #+cindex: enum, Texinfo attribute -The Texinfo export back-end converts unordered and ordered lists in +The Texinfo export backend converts unordered and ordered lists in the Org file using the default command =@itemize=. Ordered lists are numbered when exported to Texinfo format. Such @@ -15613,7 +15614,7 @@ specific number, or switch to a lettered list, as illustrated here: #+cindex: @samp{ATTR_TEXINFO}, keyword #+cindex: two-column tables, in Texinfo export #+cindex: table-type, Texinfo attribute -The Texinfo export back-end by default converts description lists in +The Texinfo export backend by default converts description lists in the Org file using the default command =@table=, which results in a table with two columns. To change this behavior, set =:table-type= attribute to either =ftable= or =vtable= value. For more information, @@ -15621,7 +15622,7 @@ see [[info:texinfo::Two-column Tables]]. #+vindex: org-texinfo-table-default-markup #+cindex: indic, Texinfo attribute -The Texinfo export back-end by default also applies a text highlight +The Texinfo export backend by default also applies a text highlight based on the defaults stored in ~org-texinfo-table-default-markup~. To override the default highlight command, specify another one with the =:indic= attribute. @@ -15629,7 +15630,7 @@ the =:indic= attribute. #+cindex: multiple items in Texinfo lists #+cindex: sep, Texinfo attribute Org syntax is limited to one entry per list item. Nevertheless, the -Texinfo export back-end can split that entry according to any text +Texinfo export backend can split that entry according to any text provided through the =:sep= attribute. Each part then becomes a new entry in the first column of the table. @@ -15668,7 +15669,7 @@ Support for this compact syntax can also be enabled for all lists in a file using the =compact-itemx= export option, or globally using the variable ~org-texinfo-compact-itemx~. -The Texinfo export back-end also supports two approaches to writing +The Texinfo export backend also supports two approaches to writing Texinfo definition commands (see [[info:texinfo::Definition Commands]]). One of them uses description lists and is described below, the other relies on special blocks (see [[*Special blocks in Texinfo export]]). @@ -15740,7 +15741,7 @@ Command in parenthesis, as done above, is optional. :END: #+cindex: @samp{ATTR_TEXINFO}, keyword -When exporting tables, the Texinfo export back-end uses the widest +When exporting tables, the Texinfo export backend uses the widest cell width in each column. To override this and instead specify as fractions of line length, use the =:columns= attribute. See example below. @@ -15757,7 +15758,7 @@ below. #+cindex: @samp{ATTR_TEXINFO}, keyword Insert a file link to the image in the Org file, and the Texinfo -export back-end inserts the image. These links must have the usual +export backend inserts the image. These links must have the usual supported image extensions and no descriptions. To scale the image, use =:width= and =:height= attributes. For alternate text, use =:alt= and specify the text using Texinfo code, as shown in the example: @@ -15828,13 +15829,13 @@ Type @kbd{C-c @key{SPC}}. :DESCRIPTION: Special block attributes. :END: -The Texinfo export back-end supports two approaches to writing Texinfo +The Texinfo export backend supports two approaches to writing Texinfo definition commands. One of them is described here, the other in [[*Plain lists in Texinfo export]]. #+cindex: @samp{ATTR_TEXINFO}, keyword -The Texinfo export back-end converts special blocks to commands with +The Texinfo export backend converts special blocks to commands with the same name. It also adds any =:options= attributes to the end of the command, as shown in this example: @@ -15936,24 +15937,24 @@ This manual is for GNU Sample (version {{{version}}}, A large part of Org mode's interoperability success is its ability to easily export to or import from external applications. The iCalendar -export back-end takes calendar data from Org files and exports to the +export backend takes calendar data from Org files and exports to the standard iCalendar format. #+vindex: org-icalendar-include-todo #+vindex: org-icalendar-use-deadline #+vindex: org-icalendar-use-scheduled -The iCalendar export back-end can also incorporate TODO entries based +The iCalendar export backend can also incorporate TODO entries based on the configuration of the ~org-icalendar-include-todo~ variable. -The back-end exports plain timestamps as =VEVENT=, TODO items as +The backend exports plain timestamps as =VEVENT=, TODO items as =VTODO=, and also create events from deadlines that are in non-TODO -items. The back-end uses the deadlines and scheduling dates in Org +items. The backend uses the deadlines and scheduling dates in Org TODO items for setting the start and due dates for the iCalendar TODO entry. Consult the ~org-icalendar-use-deadline~ and ~org-icalendar-use-scheduled~ variables for more details. #+vindex: org-icalendar-categories #+vindex: org-icalendar-alarm-time -For tags on the headline, the iCalendar export back-end makes them +For tags on the headline, the iCalendar export backend makes them into iCalendar categories. To tweak the inheritance of tags and TODO states, configure the variable ~org-icalendar-categories~. To assign clock alarms based on time, configure the ~org-icalendar-alarm-time~ @@ -15962,9 +15963,9 @@ variable. #+vindex: org-icalendar-store-UID #+cindex: @samp{ID}, property The iCalendar format standard requires globally unique identifier---or -UID---for each entry. The iCalendar export back-end creates UIDs +UID---for each entry. The iCalendar export backend creates UIDs during export. To save a copy of the UID in the Org file set the -variable ~org-icalendar-store-UID~. The back-end looks for the =ID= +variable ~org-icalendar-store-UID~. The backend looks for the =ID= property of the entry for re-using the same UID for subsequent exports. @@ -16003,15 +16004,15 @@ connections. #+cindex: @samp{LOCATION}, property #+cindex: @samp{TIMEZONE}, property #+cindex: @samp{CLASS}, property -The iCalendar export back-end includes =SUMMARY=, =DESCRIPTION=, +The iCalendar export backend includes =SUMMARY=, =DESCRIPTION=, =LOCATION=, =TIMEZONE= and =CLASS= properties from the Org entries -when exporting. To force the back-end to inherit the =LOCATION=, +when exporting. To force the backend to inherit the =LOCATION=, =TIMEZONE= and =CLASS= properties, configure the ~org-use-property-inheritance~ variable. #+vindex: org-icalendar-include-body When Org entries do not have =SUMMARY=, =DESCRIPTION=, =LOCATION= and -=CLASS= properties, the iCalendar export back-end derives the summary +=CLASS= properties, the iCalendar export backend derives the summary from the headline, and derives the description from the body of the Org item. The ~org-icalendar-include-body~ variable limits the maximum number of characters of the content are turned into its @@ -16038,18 +16039,18 @@ capabilities of the destination application. Some are more lenient than others. Consult the Org mode FAQ for advice on specific applications. -** Other Built-in Back-ends +** Other Built-in Backends :PROPERTIES: :DESCRIPTION: Exporting to a man page. :END: -Other export back-ends included with Org are: +Other export backends included with Org are: - =ox-man.el=: Export to a man page. -To activate such back-ends, either customize ~org-export-backends~ or +To activate such backends, either customize ~org-export-backends~ or load directly with =(require 'ox-man)=. On successful load, the -back-end adds new keys in the export dispatcher (see [[*The Export +backend adds new keys in the export dispatcher (see [[*The Export Dispatcher]]). Follow the comment section of such files, for example, =ox-man.el=, @@ -16074,14 +16075,14 @@ the buffer. The second hook, ~org-export-before-parsing-hook~, runs before the buffer is parsed. Functions added to these hooks are called with a single argument: the -export back-end actually used, as a symbol. You may use them for +export backend actually used, as a symbol. You may use them for heavy duty structural modifications of the document. For example, you can remove every headline in the buffer during export like this: #+begin_src emacs-lisp (defun my-headline-removal (backend) "Remove all headlines in the current buffer. -BACKEND is the export back-end being used, as a symbol." +BACKEND is the export backend being used, as a symbol." (org-map-entries (lambda () (delete-region (point) (line-beginning-position 2))))) @@ -16095,7 +16096,7 @@ BACKEND is the export back-end being used, as a symbol." #+cindex: Filters, exporting Filters are lists of functions to be applied to certain parts for -a given back-end. The output from the first function in the filter is +a given backend. The output from the first function in the filter is passed on to the next function in the filter. The final output is the output from the final function in the filter. @@ -16126,7 +16127,7 @@ is the type targeted by the filter. Valid types are: | underline | verbatim | verse-block | Here is an example filter that replaces non-breaking spaces ~ ~ in the -Org buffer with =~= for the LaTeX back-end. +Org buffer with =~= for the LaTeX backend. #+begin_src emacs-lisp (defun my-latex-filter-nobreaks (text backend info) @@ -16139,10 +16140,10 @@ Org buffer with =~= for the LaTeX back-end. #+end_src A filter requires three arguments: the code to be transformed, the -name of the back-end, and some optional information about the export +name of the backend, and some optional information about the export process. The third argument can be safely ignored. Note the use of ~org-export-derived-backend-p~ predicate that tests for /latex/ -back-end or any other back-end, such as /beamer/, derived from +backend or any other backend, such as /beamer/, derived from /latex/. *** Defining filters for individual files @@ -16150,7 +16151,7 @@ back-end or any other back-end, such as /beamer/, derived from :UNNUMBERED: notoc :END: -The Org export can filter not just for back-ends, but also for +The Org export can filter not just for backends, but also for specific files through the =BIND= keyword. Here is an example with two filters; one removes brackets from time stamps, and the other removes strike-through text. The filter functions are defined in @@ -16167,26 +16168,26 @@ debugging. ,#+END_SRC #+end_example -*** Extending an existing back-end +*** Extending an existing backend :PROPERTIES: :UNNUMBERED: notoc :END: Some parts of the conversion process can be extended for certain elements so as to introduce a new or revised translation. That is how -the HTML export back-end was extended to handle Markdown format. The +the HTML export backend was extended to handle Markdown format. The extensions work seamlessly so any aspect of filtering not done by the -extended back-end is handled by the original back-end. Of all the +extended backend is handled by the original backend. Of all the export customization in Org, extending is very powerful as it operates at the parser level. -For this example, make the /ascii/ back-end display the language used +For this example, make the /ascii/ backend display the language used in a source code block. Also make it display only when some attribute is non-~nil~, like the following: : #+ATTR_ASCII: :language t -Then extend ASCII back-end with a custom "my-ascii" back-end. +Then extend ASCII backend with a custom "my-ascii" backend. #+begin_src emacs-lisp (defun my-ascii-src-block (src-block contents info) @@ -16208,13 +16209,13 @@ channel." #+end_src The ~my-ascii-src-block~ function looks at the attribute above the -current element. If not true, hands over to /ascii/ back-end. If +current element. If not true, hands over to /ascii/ backend. If true, which it is in this example, it creates a box around the code and leaves room for the inserting a string for language. The last -form creates the new back-end that springs to action only when +form creates the new backend that springs to action only when translating ~src-block~ type elements. -To use the newly defined back-end, evaluate the following from an Org +To use the newly defined backend, evaluate the following from an Org buffer: #+begin_src emacs-lisp @@ -16230,7 +16231,7 @@ user-friendly improvements. :DESCRIPTION: Author tables and lists in Org syntax. :END: -The export back-ends in Org often include commands to convert selected +The export backends in Org often include commands to convert selected regions. A convenient feature of this in-place conversion is that the exported output replaces the original source. Here are such functions: @@ -17278,7 +17279,7 @@ Org can extract one or more source code blocks and write them to one or more source files---a process known as /tangling/ in literate programming terminology. -For exporting and publishing, Org's back-ends can format a source code +For exporting and publishing, Org's backends can format a source code block appropriately, often with native syntax highlighting. For executing and compiling a source code block, the user can @@ -21107,33 +21108,33 @@ A review of =ol-man.el=: description. The function ~org-insert-link~ can insert it back into an Org buffer later on. -** Adding Export Back-ends +** Adding Export Backends :PROPERTIES: -:DESCRIPTION: How to write new export back-ends. +:DESCRIPTION: How to write new export backends. :END: -#+cindex: Export, writing back-ends +#+cindex: Export, writing backends -Org's export engine makes it easy for writing new back-ends. The +Org's export engine makes it easy for writing new backends. The framework on which the engine was built makes it easy to derive new -back-ends from existing ones. +backends from existing ones. #+findex: org-export-define-backend #+findex: org-export-define-derived-backend The two main entry points to the export engine are: ~org-export-define-backend~ and ~org-export-define-derived-backend~. To grok these functions, see =ox-latex.el= for an example of defining -a new back-end from scratch, and =ox-beamer.el= for an example of +a new backend from scratch, and =ox-beamer.el= for an example of deriving from an existing engine. -For creating a new back-end from scratch, first set its name as +For creating a new backend from scratch, first set its name as a symbol in an alist consisting of elements and export functions. To -make the back-end visible to the export dispatcher, set ~:menu-entry~ -keyword. For export options specific to this back-end, set the +make the backend visible to the export dispatcher, set ~:menu-entry~ +keyword. For export options specific to this backend, set the ~:options-alist~. -For creating a new back-end from an existing one, set +For creating a new backend from an existing one, set ~:translate-alist~ to an alist of export functions. This alist -replaces the parent back-end functions. +replaces the parent backend functions. For complete documentation, see [[https://orgmode.org/worg/dev/org-export-reference.html][the Org Export Reference on Worg]]. @@ -21343,7 +21344,7 @@ Orgtbl mode has built-in translator functions: ~orgtbl-to-csv~ ~orgtbl-to-latex~, ~orgtbl-to-html~, ~orgtbl-to-texinfo~, ~orgtbl-to-unicode~ and ~orgtbl-to-orgtbl~. They use the generic translator, ~orgtbl-to-generic~, which delegates translations to -various export back-ends. +various export backends. Properties passed to the function through the =ORGTBL SEND= line take precedence over properties defined inside the function. For example, @@ -22637,7 +22638,7 @@ information on evaluating code blocks. Beamer---, the =org-latex-package-alist= variable needs further configuration. See [[LaTeX specific export settings]]. -[fn:42] At the moment, some export back-ends do not obey this +[fn:42] At the moment, some export backends do not obey this specification. For example, LaTeX export excludes every unnumbered headline from the table of contents. diff --git a/lisp/oc-basic.el b/lisp/oc-basic.el index 12b627e71..fdcb5bda2 100644 --- a/lisp/oc-basic.el +++ b/lisp/oc-basic.el @@ -1,4 +1,4 @@ -;;; oc-basic.el --- basic back-end for citations -*- lexical-binding: t; -*- +;;; oc-basic.el --- basic backend for citations -*- lexical-binding: t; -*- ;; Copyright (C) 2021-2023 Free Software Foundation, Inc. @@ -330,7 +330,7 @@ FIELD is a symbol. ENTRY-OR-KEY is either an association list, as returned by Optional argument INFO is the export state, as a property list. -Return value may be nil or a string. If current export back-end is derived +Return value may be nil or a string. If current export backend is derived from `latex', return a raw string instead, unless optional argument RAW is non-nil. @@ -716,7 +716,7 @@ export communication channel, as a property list." (defun org-cite-basic-export-bibliography (keys _files style _props backend info) "Generate bibliography. KEYS is the list of cited keys, as strings. STYLE is the expected bibliography -style, as a string. BACKEND is the export back-end, as a symbol. INFO is the +style, as a string. BACKEND is the export backend, as a symbol. INFO is the export state, as a property list." (mapconcat (lambda (entry) diff --git a/lisp/oc-csl.el b/lisp/oc-csl.el index 26aa8e08d..b71221e8c 100644 --- a/lisp/oc-csl.el +++ b/lisp/oc-csl.el @@ -184,8 +184,8 @@ looks for style files in this directory, too." :safe #'booleanp) (defcustom org-cite-csl-no-citelinks-backends '(ascii) - "List of export back-ends for which cite linking is disabled. -Cite linking for export back-ends derived from any of the back-ends listed here, + "List of export backends for which cite linking is disabled. +Cite linking for export backends derived from any of the backends listed here, is also disabled." :group 'org-cite :package-version '(Org . "9.5") diff --git a/lisp/oc.el b/lisp/oc.el index 66b6a5ddb..4b1420271 100644 --- a/lisp/oc.el +++ b/lisp/oc.el @@ -46,8 +46,8 @@ ;; The "export" capability is slightly more involved as one need to ;; select the processor providing it, but may also provide a default ;; style for citations and bibliography. Also, the choice of an -;; export processor may depend of the current export back-end. The -;; association between export back-ends and triplets of parameters can +;; export processor may depend of the current export backend. The +;; association between export backends and triplets of parameters can ;; be set in `org-cite-export-processors' variable, or in a document, ;; through the "cite_export" keyword. @@ -143,12 +143,12 @@ File names must be absolute." When nil, citations and bibliography are not exported. -When non-nil, the value is an association list between export back-ends and +When non-nil, the value is an association list between export backends and citation export processors: - (BACK-END . PROCESSOR) + (BACKEND . PROCESSOR) -where BACK-END is the name of an export back-end or t, and PROCESSOR is a +where BACKEND is the name of an export backend or t, and PROCESSOR is a triplet following the pattern (NAME BIBLIOGRAPHY-STYLE CITATION-STYLE) @@ -160,7 +160,7 @@ exporting a citation), as a string or nil. Both BIBLIOGRAPHY-STYLE and CITATION-STYLE are optional. NAME is mandatory. The export process selects the citation processor associated to the current -export back-end, or the most specific back-end the current one is derived from, +export backend, or the most specific backend the current one is derived from, or, if all are inadequate, to the processor associated to t. For example, with the following value @@ -168,9 +168,9 @@ the following value (latex biblatex) (t csl)) -exporting with `beamer' or any back-end derived from it will use `natbib', -whereas exporting with `latex' or any back-end derived from it but different -from `beamer' will use `biblatex' processor. Any other back-end, such as +exporting with `beamer' or any backend derived from it will use `natbib', +whereas exporting with `latex' or any backend derived from it but different +from `beamer' will use `biblatex' processor. Any other backend, such as `html', will use `csl' processor. CITATION-STYLE is overridden by adding a style to any citation object. A nil @@ -187,7 +187,7 @@ or #+CITE_EXPORT: basic In that case, `basic' processor is used on every export, independently on the -back-end." +backend." :group 'org-cite :package-version '(Org . "9.5") :type '(choice (const :tag "No export" nil) @@ -345,7 +345,7 @@ optional keys can be set: arguments: the list of citation keys used in the document, as strings, a list of bibliography files, the style, as a string or nil, the local properties, as a property list, the export - back-end, as a symbol, and the communication channel, as a + backend, as a symbol, and the communication channel, as a property list. It is called at each \"print_bibliography\" keyword in the @@ -358,7 +358,7 @@ optional keys can be set: Function rendering citations. It is called with four arguments: a citation object, the style, as a pair, the - export back-end, as a symbol, and the communication channel, + export backend, as a symbol, and the communication channel, as a property list. It is called on each citation object in the parse tree. It @@ -373,7 +373,7 @@ optional keys can be set: six arguments: the output, as a string, a list of citation keys used in the document, a list of bibliography files, the expected bibliography style, as a string or nil, the export - back-end, as a symbol, and the communication channel, as a + backend, as a symbol, and the communication channel, as a property list. It must return a string, which will become the final output @@ -654,7 +654,7 @@ in the current buffer. Positions include leading \"@\" character." (defun org-cite-main-affixes (citation) "Return main affixes for CITATION object. -Some export back-ends only support a single pair of affixes per +Some export backends only support a single pair of affixes per citation, even if it contains multiple keys. This function decides what affixes are the most appropriate. @@ -1279,12 +1279,12 @@ side-effect." ;; Value is an alist. It must come from ;; `org-cite-export-processors' variable. Find the most ;; appropriate processor according to current export - ;; back-end. + ;; backend. ((and (pred consp) alist) (let* ((backend (plist-get info :back-end)) (candidates ;; Limit candidates to processors associated to - ;; back-ends derived from or equal to the current + ;; backends derived from or equal to the current ;; one. (sort (seq-filter (pcase-lambda (`(,key . ,_)) @@ -1336,7 +1336,7 @@ selected citation processor." (defun org-cite-export-bibliography (keyword _ info) "Return bibliography associated to \"print_bibliography\" KEYWORD. -BACKEND is the export back-end, as a symbol. INFO is a plist +BACKEND is the export backend, as a symbol. INFO is a plist used as a communication channel." (pcase (plist-get info :cite-export) ('nil nil) diff --git a/lisp/ol.el b/lisp/ol.el index 9e4781f6e..e2bf90acd 100644 --- a/lisp/ol.el +++ b/lisp/ol.el @@ -114,11 +114,11 @@ below. Function that accepts four arguments: - the path, as a string, - the description as a string, or nil, - - the export back-end, + - the export backend, - the export communication channel, as a plist. When nil, export for that type of link is delegated to the - back-end. + backend. `:store' diff --git a/lisp/org-element.el b/lisp/org-element.el index e1b74ef28..5f54d1137 100644 --- a/lisp/org-element.el +++ b/lisp/org-element.el @@ -3242,13 +3242,13 @@ Assume point is at the beginning of the snippet." (re-search-forward "@@" nil t) (match-beginning 0))))) (let* ((begin (match-beginning 0)) - (back-end (match-string-no-properties 1)) + (backend (match-string-no-properties 1)) (value (buffer-substring-no-properties (match-end 0) contents-end)) (post-blank (skip-chars-forward " \t")) (end (point))) (list 'export-snippet - (list :back-end back-end + (list :back-end backend :value value :begin begin :end end diff --git a/lisp/org-lint.el b/lisp/org-lint.el index 453fc98dd..c46f5d702 100644 --- a/lisp/org-lint.el +++ b/lisp/org-lint.el @@ -46,7 +46,7 @@ ;; - deprecated export block syntax, ;; - deprecated Babel header syntax, ;; - missing language in source blocks, -;; - missing back-end in export blocks, +;; - missing backend in export blocks, ;; - invalid Babel call blocks, ;; - NAME values with a colon, ;; - wrong babel headers, @@ -509,7 +509,7 @@ Use :header-args: instead" (lambda (b) (unless (org-element-property :type b) (list (org-element-property :post-affiliated b) - "Missing back-end in export block"))))) + "Missing backend in export block"))))) (defun org-lint-invalid-babel-call-block (ast) (org-element-map ast 'babel-call @@ -1308,7 +1308,7 @@ Use \"export %s\" instead" :categories '(babel)) (org-lint-add-checker 'missing-backend-in-export-block - "Report missing back-end in export blocks" + "Report missing backend in export blocks" #'org-lint-missing-backend-in-export-block :categories '(export)) diff --git a/lisp/org-list.el b/lisp/org-list.el index 9fa072ce7..9a3afcc17 100644 --- a/lisp/org-list.el +++ b/lisp/org-list.el @@ -3334,7 +3334,7 @@ Valid parameters are: :backend, :raw - Export back-end used as a basis to transcode elements of the + Export backend used as a basis to transcode elements of the list, when no specific parameter applies to it. It is also used to translate its contents. You can prevent this by setting :raw property to a non-nil value. diff --git a/lisp/org-pcomplete.el b/lisp/org-pcomplete.el index 0567052c0..15856baf7 100644 --- a/lisp/org-pcomplete.el +++ b/lisp/org-pcomplete.el @@ -306,7 +306,7 @@ When completing for #+STARTUP, for example, this function returns "creator:" "date:" "d:" "email:" "*:" "e:" "::" "f:" "inline:" "tex:" "p:" "pri:" "':" "-:" "stat:" "^:" "toc:" "|:" "tags:" "tasks:" "<:" "todo:") - ;; OPTION items from registered back-ends. + ;; OPTION items from registered backends. (let (items) (dolist (backend (bound-and-true-p org-export-registered-backends)) diff --git a/lisp/org-table.el b/lisp/org-table.el index e0cc84ed6..d8ee7e7ad 100644 --- a/lisp/org-table.el +++ b/lisp/org-table.el @@ -5615,7 +5615,7 @@ Valid parameters are: :backend, :raw - Export back-end used as a basis to transcode elements of the + Export backend used as a basis to transcode elements of the table, when no specific parameter applies to it. It is also used to translate cells contents. You can prevent this by setting :raw property to a non-nil value. @@ -5707,7 +5707,7 @@ This may be either a string or a function of two arguments: (require 'ox) (let* ((backend (plist-get params :backend)) (custom-backend - ;; Build a custom back-end according to PARAMS. Before + ;; Build a custom backend according to PARAMS. Before ;; defining a translator, check if there is anything to do. ;; When there isn't, let BACKEND handle the element. (org-export-create-backend @@ -5717,7 +5717,7 @@ This may be either a string or a function of two arguments: (table-row . ,(org-table--to-generic-row params)) (table-cell . ,(org-table--to-generic-cell params)) ;; Macros are not going to be expanded. However, no - ;; regular back-end has a transcoder for them. We + ;; regular backend has a transcoder for them. We ;; provide one so they are not ignored, but displayed ;; as-is instead. (macro . (lambda (m c i) (org-element-macro-interpreter m nil)))))) @@ -5735,7 +5735,7 @@ This may be either a string or a function of two arguments: (princ "| ") (dolist (c e) (princ c) (princ " |")) (princ "\n"))))) (org-element-cache-reset) - ;; Add back-end specific filters, but not user-defined ones. In + ;; Add backend specific filters, but not user-defined ones. In ;; particular, make sure to call parse-tree filters on the ;; table. (setq info @@ -5794,7 +5794,7 @@ This may be either a string or a function of two arguments: ;; We use a low-level mechanism to export DATA so as to skip all ;; usual pre-processing and post-processing, i.e., hooks, Babel ;; code evaluation, include keywords and macro expansion. Only - ;; back-end specific filters are retained. + ;; backend specific filters are retained. (let ((output (org-export-data-with-backend data custom-backend info))) ;; Remove final newline. (if (org-string-nw-p output) (substring-no-properties output 0 -1) "")))) diff --git a/lisp/org.el b/lisp/org.el index 463b4f594..259260c98 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -812,7 +812,7 @@ For export specific modules, see also `org-export-backends'." (declare-function org-export-derived-backend-p "ox" (backend &rest backends)) (declare-function org-export-backend-name "ox" (backend) t) (defcustom org-export-backends '(ascii html icalendar latex odt) - "List of export back-ends that should be always available. + "List of export backends that should be always available. If a description starts with , the file is not part of Emacs and Org mode, so loading it will require that you have properly installed org-contrib @@ -844,12 +844,12 @@ value of the variable, after updating it: (dolist (backend val) (cond ((not (load (format \"ox-%s\" backend) t t)) - (message \"Problems while trying to load export back-end \\=`%s\\='\" + (message \"Problems while trying to load export backend \\=`%s\\='\" backend)) ((not (memq backend new-list)) (push backend new-list)))) (set-default \\='org-export-backends new-list))) -Adding a back-end to this list will also pull the back-end it +Adding a backend to this list will also pull the backend it depends on, if any." :group 'org :group 'org-export @@ -858,9 +858,9 @@ depends on, if any." :initialize 'custom-initialize-set :set (lambda (var val) (if (not (featurep 'ox)) (set-default-toplevel-value var val) - ;; Any back-end not required anymore (not present in VAL and not - ;; a parent of any back-end in the new value) is removed from the - ;; list of registered back-ends. + ;; Any backend not required anymore (not present in VAL and not + ;; a parent of any backend in the new value) is removed from the + ;; list of registered backends. (setq org-export-registered-backends (cl-remove-if-not (lambda (backend) @@ -871,14 +871,14 @@ depends on, if any." (and (org-export-derived-backend-p b name) (throw 'parentp t))))))) org-export-registered-backends)) - ;; Now build NEW-LIST of both new back-ends and required + ;; Now build NEW-LIST of both new backends and required ;; parents. (let ((new-list (mapcar #'org-export-backend-name org-export-registered-backends))) (dolist (backend val) (cond ((not (load (format "ox-%s" backend) t t)) - (message "Problems while trying to load export back-end `%s'" + (message "Problems while trying to load export backend `%s'" backend)) ((not (memq backend new-list)) (push backend new-list)))) ;; Set VAR to that list with fixed dependencies. @@ -906,7 +906,7 @@ depends on, if any." (eval-after-load 'ox '(dolist (backend org-export-backends) (condition-case nil (require (intern (format "ox-%s" backend))) - (error (message "Problems while trying to load export back-end `%s'" + (error (message "Problems while trying to load export backend `%s'" backend))))) (defcustom org-support-shift-select nil @@ -8868,15 +8868,15 @@ This function can be used in a hook." (defun org-get-export-keywords () "Return a list of all currently understood export keywords. Export keywords include options, block names, attributes and -keywords relative to each registered export back-end." +keywords relative to each registered export backend." (let (keywords) (dolist (backend (bound-and-true-p org-export-registered-backends) (delq nil keywords)) - ;; Back-end name (for keywords, like #+LATEX:) + ;; Backend name (for keywords, like #+LATEX:) (push (upcase (symbol-name (org-export-backend-name backend))) keywords) (dolist (option-entry (org-export-backend-options backend)) - ;; Back-end options. + ;; Backend options. (push (nth 1 option-entry) keywords))))) (defconst org-options-keywords diff --git a/lisp/ox-ascii.el b/lisp/ox-ascii.el index e267b004b..9d94241b3 100644 --- a/lisp/ox-ascii.el +++ b/lisp/ox-ascii.el @@ -1,4 +1,4 @@ -;;; ox-ascii.el --- ASCII Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-ascii.el --- ASCII Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2012-2023 Free Software Foundation, Inc. @@ -23,7 +23,7 @@ ;;; Commentary: ;; -;; This library implements an ASCII back-end for Org generic exporter. +;; This library implements an ASCII backend for Org generic exporter. ;; See Org manual for more information. ;;; Code: @@ -42,7 +42,7 @@ (declare-function org-back-to-heading "org" (&optional invisible-ok)) (declare-function org-next-visible-heading "org" (arg)) -;;; Define Back-End +;;; Define Backend ;; ;; The following setting won't allow modifying preferred charset ;; through a buffer keyword or an option item, but, since the property @@ -2048,10 +2048,10 @@ contextual information." "Filter controlling number of blank lines after a headline. HEADLINE is a string representing a transcoded headline. BACKEND -is symbol specifying back-end used for export. INFO is plist +is symbol specifying backend used for export. INFO is plist containing the communication channel. -This function only applies to `ascii' back-end. See +This function only applies to `ascii' backend. See `org-ascii-headline-spacing' for information." (let ((headline-spacing (plist-get info :ascii-headline-spacing))) (if (not headline-spacing) headline @@ -2062,7 +2062,7 @@ This function only applies to `ascii' back-end. See "Filter controlling number of blank lines between paragraphs. TREE is the parse tree. BACKEND is the symbol specifying -back-end used for export. INFO is a plist used as +backend used for export. INFO is a plist used as a communication channel. See `org-ascii-paragraph-spacing' for information." @@ -2078,7 +2078,7 @@ See `org-ascii-paragraph-spacing' for information." (defun org-ascii-filter-comment-spacing (tree _backend info) "Filter removing blank lines between comments. TREE is the parse tree. BACKEND is the symbol specifying -back-end used for export. INFO is a plist used as +backend used for export. INFO is a plist used as a communication channel." (org-element-map tree '(comment comment-block) (lambda (c) diff --git a/lisp/ox-beamer.el b/lisp/ox-beamer.el index 59483e647..ec6dc34b2 100644 --- a/lisp/ox-beamer.el +++ b/lisp/ox-beamer.el @@ -1,4 +1,4 @@ -;;; ox-beamer.el --- Beamer Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-beamer.el --- Beamer Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2007-2023 Free Software Foundation, Inc. @@ -24,7 +24,7 @@ ;;; Commentary: ;; -;; This library implements both a Beamer back-end, derived from the +;; This library implements both a Beamer backend, derived from the ;; LaTeX one and a minor mode easing structure edition of the ;; document. See Org manual for more information. @@ -166,7 +166,7 @@ which is replaced with the subtitle." ("ignoreheading" "i") ("note" "n") ("noteNH" "N")) - "Alist of environments treated in a special way by the back-end. + "Alist of environments treated in a special way by the backend. Keys are environment names, as strings, values are bindings used in `org-beamer-select-environment'. Environments listed here, along with their binding, are hard coded and cannot be modified @@ -229,7 +229,7 @@ Return overlay specification, as a string, or nil." -;;; Define Back-End +;;; Define Backend (org-export-define-derived-backend 'beamer 'latex :menu-entry @@ -377,7 +377,7 @@ CONTENTS holds the contents of the headline. INFO is a plist used as a communication channel." (let ((latex-headline (org-export-with-backend - ;; We create a temporary export back-end which behaves the + ;; We create a temporary export backend which behaves the ;; same as current one, but adds "\protect" in front of the ;; output of some objects. (org-export-create-backend @@ -715,7 +715,7 @@ channel." (let ((key (org-element-property :key keyword)) (value (org-element-property :value keyword))) ;; Handle specifically BEAMER and TOC (headlines only) keywords. - ;; Otherwise, fallback to `latex' back-end. + ;; Otherwise, fallback to `latex' backend. (cond ((equal key "BEAMER") value) ((and (equal key "TOC") (string-match "\\" value)) @@ -808,7 +808,7 @@ contextual information." ;;;; Template ;; -;; Template used is similar to the one used in `latex' back-end, +;; Template used is similar to the one used in `latex' backend, ;; excepted for the table of contents and Beamer themes. (defun org-beamer-template (contents info) diff --git a/lisp/ox-html.el b/lisp/ox-html.el index b51718c8d..b519402b1 100644 --- a/lisp/ox-html.el +++ b/lisp/ox-html.el @@ -1,4 +1,4 @@ -;;; ox-html.el --- HTML Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-html.el --- HTML Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2011-2023 Free Software Foundation, Inc. @@ -24,7 +24,7 @@ ;;; Commentary: -;; This library implements a HTML back-end for Org generic exporter. +;; This library implements a HTML backend for Org generic exporter. ;; See Org manual for more information. ;;; Code: @@ -55,7 +55,7 @@ (defvar htmlize-output-type) (defvar htmlize-css-name-prefix) -;;; Define Back-End +;;; Define Backend (org-export-define-backend 'html '((bold . org-html-bold) @@ -544,7 +544,7 @@ Option settings will replace the %MANAGER-OPTIONS cookie." (defun org-html-infojs-install-script (exp-plist _backend) "Install script in export options when appropriate. EXP-PLIST is a plist containing export options. BACKEND is the -export back-end currently used." +export backend currently used." (unless (or (memq 'body-only (plist-get exp-plist :export-options)) (not (plist-get exp-plist :html-use-infojs)) (and (eq (plist-get exp-plist :html-use-infojs) 'when-configured) diff --git a/lisp/ox-icalendar.el b/lisp/ox-icalendar.el index e4e8a3c31..163b3b983 100644 --- a/lisp/ox-icalendar.el +++ b/lisp/ox-icalendar.el @@ -1,4 +1,4 @@ -;;; ox-icalendar.el --- iCalendar Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-icalendar.el --- iCalendar Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2004-2023 Free Software Foundation, Inc. @@ -25,7 +25,7 @@ ;;; Commentary: ;; -;; This library implements an iCalendar back-end for Org generic +;; This library implements an iCalendar backend for Org generic ;; exporter. See Org manual for more information. ;; ;; It is expected to conform to RFC 5545. @@ -48,7 +48,7 @@ ;;; User-Configurable Variables (defgroup org-export-icalendar nil - "Options specific for iCalendar export back-end." + "Options specific for iCalendar export backend." :tag "Org Export iCalendar" :group 'org-export) @@ -96,7 +96,7 @@ and will fire at the event start." (defcustom org-icalendar-exclude-tags nil "Tags that exclude a tree from export. This variable allows specifying different exclude tags from other -back-ends. It can also be set with the ICALENDAR_EXCLUDE_TAGS +backends. It can also be set with the ICALENDAR_EXCLUDE_TAGS keyword." :group 'org-export-icalendar :type '(repeat (string :tag "Tag"))) @@ -305,7 +305,7 @@ re-read the iCalendar file.") -;;; Define Back-End +;;; Define Backend (org-export-define-derived-backend 'icalendar 'ascii :translate-alist '((clock . nil) @@ -561,10 +561,10 @@ runs `org-icalendar-after-save-hook'." ;;; Filters -(defun org-icalendar-clear-blank-lines (headline _back-end _info) +(defun org-icalendar-clear-blank-lines (headline _backend _info) "Remove blank lines in HEADLINE export. HEADLINE is a string representing a transcoded headline. -BACK-END and INFO are ignored." +BACKEND and INFO are ignored." (replace-regexp-in-string "^\\(?:[ \t]*\n\\)+" "" headline)) @@ -936,7 +936,7 @@ Return ICS file name." (let ((file (buffer-file-name (buffer-base-buffer)))) (when (and file org-icalendar-store-UID) (org-icalendar-create-uid file 'warn-user))) - ;; Export part. Since this back-end is backed up by `ascii', ensure + ;; Export part. Since this backend is backed up by `ascii', ensure ;; links will not be collected at the end of sections. (let ((outfile (org-export-output-file-name ".ics" subtreep))) (org-export-to-file 'icalendar outfile diff --git a/lisp/ox-koma-letter.el b/lisp/ox-koma-letter.el index 33eb0597b..0c0565bac 100644 --- a/lisp/ox-koma-letter.el +++ b/lisp/ox-koma-letter.el @@ -1,4 +1,4 @@ -;;; ox-koma-letter.el --- KOMA Scrlttr2 Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-koma-letter.el --- KOMA Scrlttr2 Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2007-2023 Free Software Foundation, Inc. @@ -26,7 +26,7 @@ ;;; Commentary: ;; -;; This library implements a KOMA Scrlttr2 back-end, derived from the +;; This library implements a KOMA Scrlttr2 backend, derived from the ;; LaTeX one. ;; ;; Depending on the desired output format, three commands are provided @@ -34,8 +34,8 @@ ;; `org-koma-letter-export-to-latex' ("tex" file) and ;; `org-koma-letter-export-to-pdf' ("pdf" file). ;; -;; On top of buffer keywords supported by `latex' back-end (see -;; `org-latex-packages-alist'), this back-end introduces the following +;; On top of buffer keywords supported by `latex' backend (see +;; `org-latex-packages-alist'), this backend introduces the following ;; keywords: ;; - CLOSING: see `org-koma-letter-closing', ;; - FROM_ADDRESS: see `org-koma-letter-from-address', @@ -466,7 +466,7 @@ e.g. \"title-subject:t\"." "Holds special content temporarily.") -;;; Define Back-End +;;; Define Backend (org-export-define-derived-backend 'koma-letter 'latex :options-alist @@ -623,7 +623,7 @@ channel." (let ((key (org-element-property :key keyword)) (value (org-element-property :value keyword))) ;; Handle specifically KOMA-LETTER keywords. Otherwise, fallback - ;; to `latex' back-end. + ;; to `latex' backend. (if (equal key "KOMA-LETTER") value (org-export-with-backend 'latex keyword contents info)))) diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index 667074a21..9bd30bbe0 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -1,4 +1,4 @@ -;;; ox-latex.el --- LaTeX Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-latex.el --- LaTeX Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2011-2023 Free Software Foundation, Inc. @@ -50,7 +50,7 @@ (defvar engrave-faces-latex-mathescape) -;;; Define Back-End +;;; Define Backend (org-export-define-backend 'latex '((bold . org-latex-bold) @@ -2274,9 +2274,9 @@ holding contextual information." ((= (length sec) 4) (if numberedp (concat (car sec) "\n%s" (nth 1 sec)) (concat (nth 2 sec) "\n%s" (nth 3 sec))))))) - ;; Create a temporary export back-end that hard-codes + ;; Create a temporary export backend that hard-codes ;; "\underline" within "\section" and alike. - (section-back-end + (section-backend (org-export-create-backend :parent 'latex :transcoders @@ -2289,7 +2289,7 @@ holding contextual information." (verbatim . (lambda (o _ _) (org-latex--protect-texttt (org-element-property :value o))))))) (text (org-export-data-with-backend - (org-element-property :title headline) section-back-end info)) + (org-element-property :title headline) section-backend info)) (todo (and (plist-get info :with-todo-keywords) (let ((todo (org-element-property :todo-keyword headline))) @@ -2341,7 +2341,7 @@ holding contextual information." todo todo-type priority (org-export-data-with-backend (org-export-get-alt-title headline info) - section-back-end info) + section-backend info) (and (eq (plist-get info :with-tags) t) tags) info)) ;; Maybe end local TOC (see `org-latex-keyword'). diff --git a/lisp/ox-man.el b/lisp/ox-man.el index bb716f7b9..c13e17364 100644 --- a/lisp/ox-man.el +++ b/lisp/ox-man.el @@ -1,4 +1,4 @@ -;;; ox-man.el --- Man Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-man.el --- Man Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2011-2023 Free Software Foundation, Inc. @@ -23,7 +23,7 @@ ;;; Commentary: ;; -;; This library implements a Man back-end for Org generic exporter. +;; This library implements a Man backend for Org generic exporter. ;; ;; To test it, run ;; @@ -51,7 +51,7 @@ -;;; Define Back-End +;;; Define Backend (org-export-define-backend 'man '((babel-call . org-man-babel-call) diff --git a/lisp/ox-md.el b/lisp/ox-md.el index 5be0ca22e..186c4e682 100644 --- a/lisp/ox-md.el +++ b/lisp/ox-md.el @@ -1,4 +1,4 @@ -;;; ox-md.el --- Markdown Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-md.el --- Markdown Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2012-2023 Free Software Foundation, Inc. @@ -23,8 +23,8 @@ ;;; Commentary: -;; This library implements a Markdown back-end (vanilla flavor) for -;; Org exporter, based on `html' back-end. See Org manual for more +;; This library implements a Markdown backend (vanilla flavor) for +;; Org exporter, based on `html' backend. See Org manual for more ;; information. ;;; Code: @@ -40,7 +40,7 @@ ;;; User-Configurable Variables (defgroup org-export-md nil - "Options specific to Markdown export back-end." + "Options specific to Markdown export backend." :tag "Org Markdown" :group 'org-export :version "24.4" @@ -92,7 +92,7 @@ headings for its own use." -;;; Define Back-End +;;; Define Backend (org-export-define-derived-backend 'md 'html :filters-alist '((:filter-parse-tree . org-md-separate-elements)) @@ -150,7 +150,7 @@ headings for its own use." "Fix blank lines between elements. TREE is the parse tree being exported. BACKEND is the export -back-end used. INFO is a plist used as a communication channel. +backend used. INFO is a plist used as a communication channel. Enforce a blank line between elements. There are two exceptions to this rule: diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index cc7137782..2ac34c8db 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -39,7 +39,7 @@ (declare-function org-back-to-heading "org" (&optional invisible-ok)) (declare-function org-next-visible-heading "org" (arg)) -;;; Define Back-End +;;; Define Backend (org-export-define-backend 'odt '((bold . org-odt-bold) diff --git a/lisp/ox-org.el b/lisp/ox-org.el index 7ffbf0eee..f0a71becd 100644 --- a/lisp/ox-org.el +++ b/lisp/ox-org.el @@ -1,4 +1,4 @@ -;;; ox-org.el --- Org Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-org.el --- Org Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2013-2023 Free Software Foundation, Inc. diff --git a/lisp/ox-publish.el b/lisp/ox-publish.el index f9c3877d7..ddd7afa35 100644 --- a/lisp/ox-publish.el +++ b/lisp/ox-publish.el @@ -27,7 +27,7 @@ ;; ;; ox-publish.el can do the following: ;; -;; + Publish all one's Org files to a given export back-end +;; + Publish all one's Org files to a given export backend ;; + Upload HTML, images, attachments and other files to a web server ;; + Exclude selected private pages from publishing ;; + Publish a clickable sitemap of pages @@ -129,14 +129,14 @@ considered relative to the base directory. When both `:include' and `:exclude' properties are given values, the exclusion step happens first. -One special property controls which back-end function to use for +One special property controls which backend function to use for publishing files in the project. This can be used to extend the set of file types publishable by `org-publish', as well as the set of output formats. `:publishing-function' - Function to publish file. Each back-end may define its + Function to publish file. Each backend may define its own (i.e. `org-latex-publish-to-pdf', `org-html-publish-to-html'). May be a list of functions, in which case each function in the list is invoked in turn. @@ -162,8 +162,8 @@ date. Some properties control details of the Org publishing process, and are equivalent to the corresponding user variables listed in -the right column. Back-end specific properties may also be -included. See the back-end documentation for more information. +the right column. Backend specific properties may also be +included. See the backend documentation for more information. :author `user-full-name' :creator `org-export-creator-string' @@ -547,12 +547,12 @@ publishing FILENAME." -;;; Tools for publishing functions in back-ends +;;; Tools for publishing functions in backends (defun org-publish-org-to (backend filename extension plist &optional pub-dir) - "Publish an Org file to a specified back-end. + "Publish an Org file to a specified backend. -BACKEND is a symbol representing the back-end used for +BACKEND is a symbol representing the backend used for transcoding. FILENAME is the filename of the Org file to be published. EXTENSION is the extension used for the output string, with the leading dot. PLIST is the property list for the @@ -841,9 +841,9 @@ Default for SITEMAP-FILENAME is `sitemap.org'." "Find the PROPERTY of FILE in project. PROPERTY is a keyword referring to an export option, as defined -in `org-export-options-alist' or in export back-ends. In the +in `org-export-options-alist' or in export backends. In the latter case, optional argument BACKEND has to be set to the -back-end where the option is defined, e.g., +backend where the option is defined, e.g., (org-publish-find-property file :subtitle \\='latex) @@ -1024,7 +1024,7 @@ the project." "Update index for a file in cache. OUTPUT is the output from transcoding current file. BACKEND is -the back-end that was used for transcoding. INFO is a plist +the backend that was used for transcoding. INFO is a plist containing publishing and export options. The index relative to current file is stored as an alist. An @@ -1138,7 +1138,7 @@ publishing directory." "Store cross-references for current published file. OUTPUT is the produced output, as a string. BACKEND is the export -back-end used, as a symbol. INFO is the final export state, as +backend used, as a symbol. INFO is the final export state, as a plist. This function is meant to be used as a final output filter. See @@ -1170,7 +1170,7 @@ option, e.g., When PREFER-CUSTOM is non-nil, and SEARCH targets a headline in FILE, return its custom ID, if any. -It only makes sense to use this if export back-end builds +It only makes sense to use this if export backend builds references with `org-export-get-reference'." (cond ((and prefer-custom diff --git a/lisp/ox-texinfo.el b/lisp/ox-texinfo.el index f822f3d11..1e194ec6b 100644 --- a/lisp/ox-texinfo.el +++ b/lisp/ox-texinfo.el @@ -1,4 +1,4 @@ -;;; ox-texinfo.el --- Texinfo Back-End for Org Export Engine -*- lexical-binding: t; -*- +;;; ox-texinfo.el --- Texinfo Backend for Org Export Engine -*- lexical-binding: t; -*- ;; Copyright (C) 2012-2023 Free Software Foundation, Inc. ;; Author: Jonathan Leech-Pepin @@ -38,7 +38,7 @@ (defvar org-texinfo-supports-math--cache) -;;; Define Back-End +;;; Define Backend (org-export-define-backend 'texinfo '((bold . org-texinfo-bold) @@ -486,7 +486,7 @@ If two strings share the same prefix (e.g. \"ISO-8859-1\" and (defun org-texinfo--normalize-headlines (tree _backend info) "Normalize headlines in TREE. -BACK-END is the symbol specifying back-end used for export. +BACKEND is the symbol specifying backend used for export. INFO is a plist used as a communication channel. Make sure every headline in TREE contains a section, since those diff --git a/lisp/ox.el b/lisp/ox.el index 8be60985f..d75a80a2e 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -36,32 +36,32 @@ ;; ;; - The transcoder walks the parse tree, ignores or treat as plain ;; text elements and objects according to export options, and -;; eventually calls back-end specific functions to do the real +;; eventually calls backend specific functions to do the real ;; transcoding, concatenating their return value along the way. ;; ;; - The filter system is activated at the very beginning and the very ;; end of the export process, and each time an element or an object ;; has been converted. It is the entry point to fine-tune standard -;; output from back-end transcoders. See "The Filter System" +;; output from backend transcoders. See "The Filter System" ;; section for more information. ;; ;; The core functions is `org-export-as'. It returns the transcoded ;; buffer as a string. Its derivatives are `org-export-to-buffer' and ;; `org-export-to-file'. ;; -;; An export back-end is defined with `org-export-define-backend'. +;; An export backend is defined with `org-export-define-backend'. ;; This function can also support specific buffer keywords, OPTION ;; keyword's items and filters. Refer to function's documentation for ;; more information. ;; -;; If the new back-end shares most properties with another one, +;; If the new backend shares most properties with another one, ;; `org-export-define-derived-backend' can be used to simplify the ;; process. ;; -;; Any back-end can define its own variables. Among them, those +;; Any backend can define its own variables. Among them, those ;; customizable should belong to the `org-export-BACKEND' group. ;; -;; Tools for common tasks across back-ends are implemented in the +;; Tools for common tasks across backends are implemented in the ;; following part of the file. ;; ;; Eventually, a dispatcher (`org-export-dispatch') is provided in the @@ -178,7 +178,7 @@ BEHAVIOR determines how Org should handle multiple keywords for Values set through KEYWORD and OPTION have precedence over DEFAULT. -All these properties should be back-end agnostic. Back-end +All these properties should be backend agnostic. Backend specific properties are set through `org-export-define-backend'. Properties redefined there have precedence over these.") @@ -243,7 +243,7 @@ The key of each association is a property name accessible through the communication channel. Its value is a configurable global variable defining initial filters. -This list is meant to install user specified filters. Back-end +This list is meant to install user specified filters. Backend developers may install their own filters using `org-export-define-backend'. Filters defined there will always be prepended to the current list, so they always get applied @@ -292,7 +292,7 @@ value in the external process.") This is an alist: its CAR is the source of the result (destination file or buffer for a finished process, original buffer for a running one) and its CDR is a list -containing the back-end used, as a symbol, and either a process +containing the backend used, as a symbol, and either a process or the time at which it finished. It is used to build the menu from `org-export-stack'.") @@ -313,14 +313,14 @@ uses the same subtree if the previous command was restricted to a subtree.") ;; For compatibility with Org < 8 (defvar org-export-current-backend nil - "Name, if any, of the back-end used during an export process. + "Name, if any, of the backend used during an export process. Its value is a symbol such as `html', `latex', `ascii', or nil if -the back-end is anonymous (see `org-export-create-backend') or if +the backend is anonymous (see `org-export-create-backend') or if there is no export process in progress. It can be used to teach Babel blocks how to act differently -according to the back-end used.") +according to the backend used.") @@ -330,7 +330,7 @@ according to the back-end used.") ;; ;; They should never be accessed directly, as their value is to be ;; stored in a property list (cf. `org-export-options-alist'). -;; Back-ends will read their value from there instead. +;; Backends will read their value from there instead. (defgroup org-export nil "Options for exporting Org mode files." @@ -521,7 +521,7 @@ t Allow export of math snippets." "The last level which is still exported as a headline. Inferior levels will usually produce itemize or enumerate lists -when exported, but back-end behavior may differ. +when exported, but backend behavior may differ. This option can also be set with the OPTIONS keyword, e.g. \"H:2\"." @@ -873,7 +873,7 @@ This option can also be set with the OPTIONS keyword, e.g., (const :tag "Raise an error" nil))) (defcustom org-export-snippet-translation-alist nil - "Alist between export snippets back-ends and exporter back-ends. + "Alist between export snippets backends and exporter backends. This variable allows providing shortcuts for export snippets. @@ -882,14 +882,14 @@ For example, with: (setq org-export-snippet-translation-alist \\='((\"h\" . \"html\"))) -the HTML back-end will recognize the contents of \"@@h:@@\" as -HTML code while every other back-end will ignore it." +the HTML backend will recognize the contents of \"@@h:@@\" as +HTML code while every other backend will ignore it." :group 'org-export-general :version "24.4" :package-version '(Org . "8.0") :type '(repeat (cons (string :tag "Shortcut") - (string :tag "Back-end"))) + (string :tag "Backend"))) :safe (lambda (x) (and (listp x) (cl-every #'consp x) @@ -999,34 +999,34 @@ mode." -;;; Defining Back-ends +;;; Defining Backends ;; -;; An export back-end is a structure with `org-export-backend' type +;; An export backend is a structure with `org-export-backend' type ;; and `name', `parent', `transcoders', `options', `filters', `blocks' ;; and `menu' slots. ;; -;; At the lowest level, a back-end is created with +;; At the lowest level, a backend is created with ;; `org-export-create-backend' function. ;; -;; A named back-end can be registered with -;; `org-export-register-backend' function. A registered back-end can +;; A named backend can be registered with +;; `org-export-register-backend' function. A registered backend can ;; later be referred to by its name, with `org-export-get-backend' -;; function. Also, such a back-end can become the parent of a derived -;; back-end from which slot values will be inherited by default. -;; `org-export-derived-backend-p' can check if a given back-end is -;; derived from a list of back-end names. +;; function. Also, such a backend can become the parent of a derived +;; backend from which slot values will be inherited by default. +;; `org-export-derived-backend-p' can check if a given backend is +;; derived from a list of backend names. ;; ;; `org-export-get-all-transcoders', `org-export-get-all-options' and ;; `org-export-get-all-filters' return the full alist of transcoders, ;; options and filters, including those inherited from ancestors. ;; ;; At a higher level, `org-export-define-backend' is the standard way -;; to define an export back-end. If the new back-end is similar to -;; a registered back-end, `org-export-define-derived-backend' may be +;; to define an export backend. If the new backend is similar to +;; a registered backend, `org-export-define-derived-backend' may be ;; used instead. ;; ;; Eventually `org-export-barf-if-invalid-backend' returns an error -;; when a given back-end hasn't been registered yet. +;; when a given backend hasn't been registered yet. (cl-defstruct (org-export-backend (:constructor org-export-create-backend) (:copier nil)) @@ -1034,24 +1034,24 @@ mode." ;;;###autoload (defun org-export-get-backend (name) - "Return export back-end named after NAME. -NAME is a symbol. Return nil if no such back-end is found." + "Return export backend named after NAME. +NAME is a symbol. Return nil if no such backend is found." (cl-find-if (lambda (b) (and (eq name (org-export-backend-name b)))) org-export-registered-backends)) (defun org-export-register-backend (backend) - "Register BACKEND as a known export back-end. + "Register BACKEND as a known export backend. BACKEND is a structure with `org-export-backend' type." - ;; Refuse to register an unnamed back-end. + ;; Refuse to register an unnamed backend. (unless (org-export-backend-name backend) - (error "Cannot register a unnamed export back-end")) - ;; Refuse to register a back-end with an unknown parent. + (error "Cannot register a unnamed export backend")) + ;; Refuse to register a backend with an unknown parent. (let ((parent (org-export-backend-parent backend))) (when (and parent (not (org-export-get-backend parent))) - (error "Cannot use unknown \"%s\" back-end as a parent" parent))) - ;; If a back-end with the same name as BACKEND is already + (error "Cannot use unknown \"%s\" backend as a parent" parent))) + ;; If a backend with the same name as BACKEND is already ;; registered, replace it with BACKEND. Otherwise, simply add - ;; BACKEND to the list of registered back-ends. + ;; BACKEND to the list of registered backends. (let ((old (org-export-get-backend (org-export-backend-name backend)))) (if old (setcar (memq old org-export-registered-backends) backend) (push backend org-export-registered-backends)))) @@ -1059,14 +1059,14 @@ BACKEND is a structure with `org-export-backend' type." (defun org-export-barf-if-invalid-backend (backend) "Signal an error if BACKEND isn't defined." (unless (org-export-backend-p backend) - (error "Unknown \"%s\" back-end: Aborting export" backend))) + (error "Unknown \"%s\" backend: Aborting export" backend))) ;;;###autoload (defun org-export-derived-backend-p (backend &rest backends) "Non-nil if BACKEND is derived from one of BACKENDS. -BACKEND is an export back-end, as returned by, e.g., +BACKEND is an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. BACKENDS is constituted of symbols." +a registered backend. BACKENDS is constituted of symbols." (when (symbolp backend) (setq backend (org-export-get-backend backend))) (when backend (catch 'exit @@ -1080,13 +1080,13 @@ a registered back-end. BACKENDS is constituted of symbols." (defun org-export-get-all-transcoders (backend) "Return full translation table for BACKEND. -BACKEND is an export back-end, as return by, e.g,, +BACKEND is an export backend, as return by, e.g,, `org-export-create-backend'. Return value is an alist where keys are element or object types, as symbols, and values are transcoders. Unlike to `org-export-backend-transcoders', this function -also returns transcoders inherited from parent back-ends, +also returns transcoders inherited from parent backends, if any." (when (symbolp backend) (setq backend (org-export-get-backend backend))) (when backend @@ -1101,12 +1101,12 @@ if any." (defun org-export-get-all-options (backend) "Return export options for BACKEND. -BACKEND is an export back-end, as return by, e.g,, +BACKEND is an export backend, as return by, e.g,, `org-export-create-backend'. See `org-export-options-alist' for the shape of the return value. Unlike to `org-export-backend-options', this function also -returns options inherited from parent back-ends, if any. +returns options inherited from parent backends, if any. Return nil if BACKEND is unknown." (when (symbolp backend) (setq backend (org-export-get-backend backend))) @@ -1121,12 +1121,12 @@ Return nil if BACKEND is unknown." (defun org-export-get-all-filters (backend) "Return complete list of filters for BACKEND. -BACKEND is an export back-end, as return by, e.g,, +BACKEND is an export backend, as return by, e.g,, `org-export-create-backend'. Return value is an alist where keys are symbols and values lists of functions. Unlike to `org-export-backend-filters', this function also -returns filters inherited from parent back-ends, if any." +returns filters inherited from parent backends, if any." (when (symbolp backend) (setq backend (org-export-get-backend backend))) (when backend (let ((filters (org-export-backend-filters backend)) @@ -1137,7 +1137,7 @@ returns filters inherited from parent back-ends, if any." filters))) (defun org-export-define-backend (backend transcoders &rest body) - "Define a new back-end BACKEND. + "Define a new backend BACKEND. TRANSCODERS is an alist between object or element types and functions handling them. @@ -1173,7 +1173,7 @@ The latter, when defined, is to be called on every text not recognized as an element or an object. It must accept two arguments: the text string and the information channel. It is an appropriate place to protect special chars relative to the -back-end. +backend. BODY can start with pre-defined keyword arguments. The following keywords are understood: @@ -1181,9 +1181,9 @@ keywords are understood: :filters-alist Alist between filters and function, or list of functions, - specific to the back-end. See `org-export-filters-alist' for + specific to the backend. See `org-export-filters-alist' for a list of all allowed filters. Filters defined here - shouldn't make a back-end test, as it may prevent back-ends + shouldn't make a backend test, as it may prevent backends derived from this one to behave properly. :menu-entry @@ -1195,13 +1195,13 @@ keywords are understood: where : - KEY is a free character selecting the back-end. + KEY is a free character selecting the backend. DESCRIPTION-OR-ORDINAL is either a string or a number. - If it is a string, is will be used to name the back-end in + If it is a string, is will be used to name the backend in its menu entry. If it is a number, the following menu will - be displayed as a sub-menu of the back-end with the same + be displayed as a sub-menu of the backend with the same KEY. Also, the number will be used to determine in which order such sub-menus will appear (lowest first). @@ -1221,7 +1221,7 @@ keywords are understood: Valid values include: - (?m \"My Special Back-end\" my-special-export-function) + (?m \"My Special Backend\" my-special-export-function) or @@ -1242,7 +1242,7 @@ keywords are understood: :options-alist - Alist between back-end specific properties introduced in + Alist between backend specific properties introduced in communication channel and how their value are acquired. See `org-export-options-alist' for more information about structure of the values." @@ -1263,10 +1263,10 @@ keywords are understood: :menu menu-entry)))) (defun org-export-define-derived-backend (child parent &rest body) - "Create a new back-end as a variant of an existing one. + "Create a new backend as a variant of an existing one. -CHILD is the name of the derived back-end. PARENT is the name of -the parent back-end. +CHILD is the name of the derived backend. PARENT is the name of +the parent backend. BODY can start with pre-defined keyword arguments. The following keywords are understood: @@ -1274,7 +1274,7 @@ keywords are understood: :filters-alist Alist of filters that will overwrite or complete filters - defined in PARENT back-end. See `org-export-filters-alist' + defined in PARENT backend. See `org-export-filters-alist' for a list of allowed filters. :menu-entry @@ -1285,25 +1285,25 @@ keywords are understood: :options-alist - Alist of back-end specific properties that will overwrite or - complete those defined in PARENT back-end. Refer to + Alist of backend specific properties that will overwrite or + complete those defined in PARENT backend. Refer to `org-export-options-alist' for more information about structure of the values. :translate-alist Alist of element and object types and transcoders that will - overwrite or complete transcode table from PARENT back-end. + overwrite or complete transcode table from PARENT backend. Refer to `org-export-define-backend' for detailed information about transcoders. -As an example, here is how one could define \"my-latex\" back-end -as a variant of `latex' back-end with a custom template function: +As an example, here is how one could define \"my-latex\" backend +as a variant of `latex' backend with a custom template function: (org-export-define-derived-backend \\='my-latex \\='latex :translate-alist \\='((template . my-latex-template-fun))) -The back-end could then be called with, for example: +The backend could then be called with, for example: (org-export-to-buffer \\='my-latex \"*Test my-latex*\")" (declare (indent 2)) @@ -1374,7 +1374,7 @@ The back-end could then be called with, for example: (defun org-export-get-environment (&optional backend subtreep ext-plist) "Collect export options from the current buffer. -Optional argument BACKEND is an export back-end, as returned by +Optional argument BACKEND is an export backend, as returned by `org-export-create-backend'. When optional argument SUBTREEP is non-nil, assume the export is @@ -1400,8 +1400,8 @@ inferior to file-local settings." (defun org-export--parse-option-keyword (options &optional backend) "Parse an OPTIONS line and return values as a plist. -Optional argument BACKEND is an export back-end, as returned by, -e.g., `org-export-create-backend'. It specifies which back-end +Optional argument BACKEND is an export backend, as returned by, +e.g., `org-export-create-backend'. It specifies which backend specific items to read, if any." (let ((line (let (alist) @@ -1414,7 +1414,7 @@ specific items to read, if any." (read (current-buffer))) ; moves point alist)))) alist)) - ;; Priority is given to back-end specific options. + ;; Priority is given to backend specific options. (all (append (org-export-get-all-options backend) org-export-options-alist)) (plist)) @@ -1427,8 +1427,8 @@ specific items to read, if any." (defun org-export--get-subtree-options (&optional backend) "Get export options in subtree at point. -Optional argument BACKEND is an export back-end, as returned by, -e.g., `org-export-create-backend'. It specifies back-end used +Optional argument BACKEND is an export backend, as returned by, +e.g., `org-export-create-backend'. It specifies backend used for export. Return options as a plist." ;; For each buffer keyword, create a headline property setting the ;; same property in communication channel. The name for the @@ -1450,7 +1450,7 @@ for export. Return options as a plist." (let ((case-fold-search nil)) (looking-at org-complex-heading-regexp) (match-string-no-properties 4)))))) - ;; Look for both general keywords and back-end specific + ;; Look for both general keywords and backend specific ;; options, with priority given to the latter. (options (append (org-export-get-all-options backend) org-export-options-alist))) @@ -1479,15 +1479,15 @@ for export. Return options as a plist." (defun org-export--get-inbuffer-options (&optional backend) "Return current buffer export options, as a plist. -Optional argument BACKEND, when non-nil, is an export back-end, +Optional argument BACKEND, when non-nil, is an export backend, as returned by, e.g., `org-export-create-backend'. It specifies -which back-end specific options should also be read in the +which backend specific options should also be read in the process. Assume buffer is in Org mode. Narrowing, if any, is ignored." (let* ((case-fold-search t) (options (append - ;; Priority is given to back-end specific options. + ;; Priority is given to backend specific options. (org-export-get-all-options backend) org-export-options-alist)) plist to-parse) @@ -1575,12 +1575,12 @@ are like the arguments with the same names of function (defun org-export--get-global-options (&optional backend) "Return global export options as a plist. -Optional argument BACKEND, if non-nil, is an export back-end, as +Optional argument BACKEND, if non-nil, is an export backend, as returned by, e.g., `org-export-create-backend'. It specifies -which back-end specific export options should also be read in the +which backend specific export options should also be read in the process." (let (plist - ;; Priority is given to back-end specific options. + ;; Priority is given to backend specific options. (all (append (org-export-get-all-options backend) org-export-options-alist))) (dolist (cell all plist) @@ -1853,13 +1853,13 @@ not exported." ;; ;; `org-export-data' reads a parse tree (obtained with, i.e. ;; `org-element-parse-buffer') and transcodes it into a specified -;; back-end output. It takes care of filtering out elements or +;; backend output. It takes care of filtering out elements or ;; objects according to export options and organizing the output blank ;; lines and white space are preserved. The function memoizes its ;; results, so it is cheap to call it within transcoders. ;; -;; It is possible to modify locally the back-end used by -;; `org-export-data' or even use a temporary back-end by using +;; It is possible to modify locally the backend used by +;; `org-export-data' or even use a temporary backend by using ;; `org-export-data-with-backend'. ;; ;; `org-export-transcoder' is an accessor returning appropriate @@ -1876,7 +1876,7 @@ INFO is a plist containing export directives." ;;;###autoload (defun org-export-data (data info) - "Convert DATA into current back-end format. + "Convert DATA into current backend format. DATA is a parse tree, an element or an object or a secondary string. INFO is a plist holding export options. @@ -2011,8 +2011,8 @@ recursively convert DATA using BACKEND translation table." :exported-data (make-hash-table :test 'eq :size 401))))) (prog1 (org-export-data data new-info) ;; Preserve `:internal-references', as those do not depend on - ;; the back-end used; we need to make sure that any new - ;; reference when the temporary back-end was active gets through + ;; the backend used; we need to make sure that any new + ;; reference when the temporary backend was active gets through ;; the default one. (plist-put info :internal-references (plist-get new-info :internal-references))))) @@ -2040,9 +2040,9 @@ keywords before output." ;; They are the functional counterpart of hooks, as every filter in ;; a set is applied to the return value of the previous one. ;; -;; Every set is back-end agnostic. Although, a filter is always -;; called, in addition to the string it applies to, with the back-end -;; used as argument, so it's easy for the end-user to add back-end +;; Every set is backend agnostic. Although, a filter is always +;; called, in addition to the string it applies to, with the backend +;; used as argument, so it's easy for the end-user to add backend ;; specific filters in the set. The communication channel, as ;; a plist, is required as the third argument. ;; @@ -2055,7 +2055,7 @@ keywords before output." ;; - `:filter-options' applies to the property list containing export ;; options. Unlike to other filters, functions in this list accept ;; two arguments instead of three: the property list containing -;; export options and the back-end. Users can set its value through +;; export options and the backend. Users can set its value through ;; `org-export-filter-options-functions' variable. ;; ;; - `:filter-parse-tree' applies directly to the complete parsed @@ -2103,7 +2103,7 @@ being exported. Visibility and narrowing are preserved. Point is at the beginning of the buffer. Every function in this hook will be called with one argument: the -back-end currently used, as a symbol.") +backend currently used, as a symbol.") (defvar org-export-before-parsing-functions nil "Abnormal hook run before parsing an export buffer. @@ -2114,7 +2114,7 @@ being exported. Visibility and narrowing are preserved. Point is at the beginning of the buffer. Every function in this hook will be called with one argument: the -back-end currently used, as a symbol.") +backend currently used, as a symbol.") ;;;; Special Filters @@ -2122,34 +2122,34 @@ back-end currently used, as a symbol.") (defvar org-export-filter-options-functions nil "List of functions applied to the export options. Each filter is called with two arguments: the export options, as -a plist, and the back-end, as a symbol. It must return +a plist, and the backend, as a symbol. It must return a property list containing export options.") (defvar org-export-filter-parse-tree-functions nil "List of functions applied to the parsed tree. Each filter is called with three arguments: the parse tree, as -returned by `org-element-parse-buffer', the back-end, as +returned by `org-element-parse-buffer', the backend, as a symbol, and the communication channel, as a plist. It must return the modified parse tree to transcode.") (defvar org-export-filter-plain-text-functions nil "List of functions applied to plain text. Each filter is called with three arguments: a string which -contains no Org syntax, the back-end, as a symbol, and the +contains no Org syntax, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-body-functions nil "List of functions applied to transcoded body. Each filter is called with three arguments: a string which -contains no Org syntax, the back-end, as a symbol, and the +contains no Org syntax, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-final-output-functions nil "List of functions applied to the transcoded string. Each filter is called with three arguments: the full transcoded -string, the back-end, as a symbol, and the communication channel, +string, the backend, as a symbol, and the communication channel, as a plist. It must return a string that will be used as the final export output.") @@ -2159,176 +2159,176 @@ final export output.") (defvar org-export-filter-babel-call-functions nil "List of functions applied to a transcoded babel-call. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-center-block-functions nil "List of functions applied to a transcoded center block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-clock-functions nil "List of functions applied to a transcoded clock. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-diary-sexp-functions nil "List of functions applied to a transcoded diary-sexp. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-drawer-functions nil "List of functions applied to a transcoded drawer. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-dynamic-block-functions nil "List of functions applied to a transcoded dynamic-block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-example-block-functions nil "List of functions applied to a transcoded example-block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-export-block-functions nil "List of functions applied to a transcoded export-block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-fixed-width-functions nil "List of functions applied to a transcoded fixed-width. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-footnote-definition-functions nil "List of functions applied to a transcoded footnote-definition. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-headline-functions nil "List of functions applied to a transcoded headline. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-horizontal-rule-functions nil "List of functions applied to a transcoded horizontal-rule. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-inlinetask-functions nil "List of functions applied to a transcoded inlinetask. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-item-functions nil "List of functions applied to a transcoded item. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-keyword-functions nil "List of functions applied to a transcoded keyword. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-latex-environment-functions nil "List of functions applied to a transcoded latex-environment. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-node-property-functions nil "List of functions applied to a transcoded node-property. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-paragraph-functions nil "List of functions applied to a transcoded paragraph. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-plain-list-functions nil "List of functions applied to a transcoded plain-list. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-planning-functions nil "List of functions applied to a transcoded planning. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-property-drawer-functions nil "List of functions applied to a transcoded property-drawer. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-quote-block-functions nil "List of functions applied to a transcoded quote block. Each filter is called with three arguments: the transcoded quote -data, as a string, the back-end, as a symbol, and the +data, as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-section-functions nil "List of functions applied to a transcoded section. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-special-block-functions nil "List of functions applied to a transcoded special block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-src-block-functions nil "List of functions applied to a transcoded src-block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-table-functions nil "List of functions applied to a transcoded table. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-table-cell-functions nil "List of functions applied to a transcoded table-cell. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-table-row-functions nil "List of functions applied to a transcoded table-row. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-verse-block-functions nil "List of functions applied to a transcoded verse block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") @@ -2337,128 +2337,128 @@ channel, as a plist. It must return a string or nil.") (defvar org-export-filter-bold-functions nil "List of functions applied to transcoded bold text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-code-functions nil "List of functions applied to transcoded code text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-entity-functions nil "List of functions applied to a transcoded entity. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-export-snippet-functions nil "List of functions applied to a transcoded export-snippet. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-footnote-reference-functions nil "List of functions applied to a transcoded footnote-reference. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-inline-babel-call-functions nil "List of functions applied to a transcoded inline-babel-call. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-inline-src-block-functions nil "List of functions applied to a transcoded inline-src-block. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-italic-functions nil "List of functions applied to transcoded italic text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-latex-fragment-functions nil "List of functions applied to a transcoded latex-fragment. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-line-break-functions nil "List of functions applied to a transcoded line-break. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-link-functions nil "List of functions applied to a transcoded link. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-radio-target-functions nil "List of functions applied to a transcoded radio-target. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-statistics-cookie-functions nil "List of functions applied to a transcoded statistics-cookie. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-strike-through-functions nil "List of functions applied to transcoded strike-through text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-subscript-functions nil "List of functions applied to a transcoded subscript. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-superscript-functions nil "List of functions applied to a transcoded superscript. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-target-functions nil "List of functions applied to a transcoded target. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-timestamp-functions nil "List of functions applied to a transcoded timestamp. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-underline-functions nil "List of functions applied to transcoded underline text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") (defvar org-export-filter-verbatim-functions nil "List of functions applied to transcoded verbatim text. Each filter is called with three arguments: the transcoded data, -as a string, the back-end, as a symbol, and the communication +as a string, the backend, as a symbol, and the communication channel, as a plist. It must return a string or nil.") ;;;; Filters Tools ;; ;; Internal function `org-export-install-filters' installs filters -;; hard-coded in back-ends (developer filters) and filters from global +;; hard-coded in backends (developer filters) and filters from global ;; variables (user filters) in the communication channel. ;; ;; Internal function `org-export-filter-apply-functions' takes care @@ -2470,7 +2470,7 @@ channel, as a plist. It must return a string or nil.") "Call every function in FILTERS. Functions are called with three arguments: a value, the export -back-end name and the communication channel. First function in +backend name and the communication channel. First function in FILTERS is called with VALUE as its first argument. Second function in FILTERS is called with the previous result as its value, etc. @@ -2507,7 +2507,7 @@ Return the updated communication channel." (append (if (listp info-value) info-value (list info-value)) default-value))))) - ;; Prepend back-end specific filters to that list. + ;; Prepend backend specific filters to that list. (dolist (p (org-export-get-all-filters (plist-get info :back-end))) ;; Single values get consed, lists are appended. (let ((key (car p)) (value (cdr p))) @@ -2545,7 +2545,7 @@ Return the updated communication channel." ;; associated to the file, that is before parsing. ;; ;; `org-export-insert-default-template' is a command to insert -;; a default template (or a back-end specific template) at point or in +;; a default template (or a backend specific template) at point or in ;; current subtree. (cl-defun org-export-copy-buffer (&key to-buffer drop-visibility @@ -2805,7 +2805,7 @@ from tree." ;; Prune tree and communication channel. (funcall walk-data data) (dolist (entry (append - ;; Priority is given to back-end specific options. + ;; Priority is given to backend specific options. (org-export-get-all-options (plist-get info :back-end)) org-export-options-alist)) (when (eq (nth 4 entry) 'parse) @@ -3018,9 +3018,9 @@ returned by the function." (backend &optional subtreep visible-only body-only ext-plist) "Transcode current Org buffer into BACKEND code. -BACKEND is either an export back-end, as returned by, e.g., +BACKEND is either an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. +a registered backend. If narrowing is active in the current buffer, only transcode its narrowed part. @@ -3124,7 +3124,7 @@ still inferior to file-local settings." (append (org-export-get-all-options backend) org-export-options-alist)))) tree modified-tick) - ;; Run first hook with current back-end's name as argument. + ;; Run first hook with current backend's name as argument. (run-hook-with-args 'org-export-before-processing-hook (org-export-backend-name backend)) (org-export-expand-include-keyword) @@ -3147,7 +3147,7 @@ still inferior to file-local settings." (org-set-regexps-and-options) (org-update-radio-target-regexp)) (setq modified-tick (buffer-chars-modified-tick))) - ;; Run last hook with current back-end's name as argument. + ;; Run last hook with current backend's name as argument. ;; Update buffer properties and radio targets one last time ;; before parsing. (goto-char (point-min)) @@ -3211,9 +3211,9 @@ still inferior to file-local settings." (defun org-export-string-as (string backend &optional body-only ext-plist) "Transcode STRING into BACKEND code. -BACKEND is either an export back-end, as returned by, e.g., +BACKEND is either an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. +a registered backend. When optional argument BODY-ONLY is non-nil, only return body code, without preamble nor postamble. @@ -3231,9 +3231,9 @@ Return code as a string." ;;;###autoload (defun org-export-replace-region-by (backend) "Replace the active region by its export to BACKEND. -BACKEND is either an export back-end, as returned by, e.g., +BACKEND is either an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end." +a registered backend." (unless (org-region-active-p) (user-error "No active region to replace")) (insert (org-export-string-as @@ -3244,7 +3244,7 @@ a registered back-end." "Insert all export keywords with default values at beginning of line. BACKEND is a symbol referring to the name of a registered export -back-end, for which specific export options should be added to +backend, for which specific export options should be added to the template, or `default' for default template. When it is nil, the user will be prompted for a category. @@ -3304,7 +3304,7 @@ locally for the subtree through node properties." (cl-incf width (1+ (length item)))))) (insert "\n"))))) ;; Then the rest of keywords, in the order specified in either - ;; `org-export-options-alist' or respective export back-ends. + ;; `org-export-options-alist' or respective export backends. (dolist (key (nreverse keywords)) (let ((val (cond ((equal (car key) "DATE") (or (cdr key) @@ -3816,10 +3816,10 @@ See also `org-export-copy-to-kill-ring'." -;;; Tools For Back-Ends +;;; Tools For Backends ;; ;; A whole set of tools is available to help build new exporters. Any -;; function general enough to have its use across many back-ends +;; function general enough to have its use across many backends ;; should be added here. ;;;; For Affiliated Keywords @@ -3889,18 +3889,18 @@ Caption lines are separated by a white space." (cdr caption))) -;;;; For Derived Back-ends +;;;; For Derived Backends ;; ;; `org-export-with-backend' is a function allowing to locally use -;; another back-end to transcode some object or element. In a derived -;; back-end, it may be used as a fall-back function once all specific +;; another backend to transcode some object or element. In a derived +;; backend, it may be used as a fall-back function once all specific ;; cases have been treated. (defun org-export-with-backend (backend data &optional contents info) "Call a transcoder from BACKEND on DATA. -BACKEND is an export back-end, as returned by, e.g., +BACKEND is an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. DATA is an Org element, object, secondary +a registered backend. DATA is an Org element, object, secondary string or string. CONTENTS, when non-nil, is the transcoded contents of DATA element, as a string. INFO, when non-nil, is the communication channel used for export, as a plist." @@ -3918,7 +3918,7 @@ the communication channel used for export, as a plist." :back-end backend :translate-alist all-transcoders :exported-data (make-hash-table :test #'eq :size 401))))) - ;; `:internal-references' are shared across back-ends. + ;; `:internal-references' are shared across backends. (prog1 (if (eq type 'plain-text) (funcall transcoder data new-info) (funcall transcoder data contents new-info)) @@ -3928,20 +3928,20 @@ the communication channel used for export, as a plist." ;;;; For Export Snippets ;; -;; Every export snippet is transmitted to the back-end. Though, the +;; Every export snippet is transmitted to the backend. Though, the ;; latter will only retain one type of export-snippet, ignoring -;; others, based on the former's target back-end. The function -;; `org-export-snippet-backend' returns that back-end for a given +;; others, based on the former's target backend. The function +;; `org-export-snippet-backend' returns that backend for a given ;; export-snippet. (defun org-export-snippet-backend (export-snippet) - "Return EXPORT-SNIPPET targeted back-end as a symbol. + "Return EXPORT-SNIPPET targeted backend as a symbol. Translation, with `org-export-snippet-translation-alist', is applied." - (let ((back-end (org-element-property :back-end export-snippet))) + (let ((backend (org-element-property :back-end export-snippet))) (intern - (or (cdr (assoc back-end org-export-snippet-translation-alist)) - back-end)))) + (or (cdr (assoc backend org-export-snippet-translation-alist)) + backend)))) ;;;; For Footnotes @@ -3952,7 +3952,7 @@ applied." ;; transcoded data. ;; ;; `org-export-footnote-first-reference-p' is a predicate used by some -;; back-ends, when they need to attach the footnote definition only to +;; backends, when they need to attach the footnote definition only to ;; the first occurrence of the corresponding label. ;; ;; `org-export-get-footnote-definition' and @@ -4356,11 +4356,11 @@ meant to be translated with `org-export-data' or alike." "Try exporting LINK object with a dedicated function. DESC is its description, as a string, or nil. BACKEND is the -back-end used for export, as a symbol. +backend used for export, as a symbol. Return output as a string, or nil if no protocol handles LINK. -A custom protocol has precedence over regular back-end export. +A custom protocol has precedence over regular backend export. The function ignores links with an implicit type (e.g., \"custom-id\")." (let ((type (org-element-property :type link))) @@ -4414,13 +4414,13 @@ This only applies to links without a description." "Insert image links in DATA. Org syntax does not support nested links. Nevertheless, some -export back-ends support images as descriptions of links. Since +export backends support images as descriptions of links. Since images are really links to image files, we need to make an exception about links nesting. This function recognizes links whose contents are really images and turn them into proper nested links. It is meant to be used -as a parse tree filter in back-ends supporting such constructs. +as a parse tree filter in backends supporting such constructs. DATA is a parse tree. INFO is the current state of the export process, as a plist. @@ -4559,7 +4559,7 @@ Return value can be an object or an element: - Otherwise, throw an error. PSEUDO-TYPES are pseudo-elements types, i.e., elements defined -specifically in an export back-end, that could have a name +specifically in an export backend, that could have a name affiliated keyword. Assume LINK type is \"fuzzy\". White spaces are not @@ -4896,13 +4896,13 @@ objects of the same type." ;;;; For Raw objects ;; ;; `org-export-raw-string' builds a pseudo-object out of a string -;; that any export back-end returns as-is. +;; that any export backend returns as-is. ;;;###autoload (defun org-export-raw-string (s) "Return a raw object containing string S. A raw string is exported as-is, with no additional processing -from the export back-end." +from the export backend." (unless (stringp s) (error "Wrong raw contents type: %S" s)) (org-element-create 'raw nil s)) @@ -5575,7 +5575,7 @@ return nil." ;; `org-export-collect-tables', `org-export-collect-figures' and ;; `org-export-collect-listings' can be derived from it. ;; -;; `org-export-toc-entry-backend' builds a special anonymous back-end +;; `org-export-toc-entry-backend' builds a special anonymous backend ;; useful to export table of contents' entries. (defun org-export-collect-headlines (info &optional n scope) @@ -5651,7 +5651,7 @@ collected. A figure is a paragraph type element, with a caption, verifying PREDICATE. The latter has to be provided since a \"figure\" is -a vague concept that may depend on back-end. +a vague concept that may depend on backend. Return a list of elements recognized as figures." (org-export-collect-elements 'paragraph info predicate)) @@ -5679,12 +5679,12 @@ required on headlines excluded from table of contents." (equal "notoc" (org-export-get-node-property :UNNUMBERED headline t)))) (defun org-export-toc-entry-backend (parent &rest transcoders) - "Return an export back-end appropriate for table of contents entries. + "Return an export backend appropriate for table of contents entries. -PARENT is an export back-end the returned back-end should inherit +PARENT is an export backend the returned backend should inherit from. -By default, the back-end removes footnote references and targets. +By default, the backend removes footnote references and targets. It also changes links and radio targets into regular text. TRANSCODERS optional argument, when non-nil, specifies additional transcoders. A transcoder follows the pattern (TYPE . FUNCTION) @@ -6625,7 +6625,7 @@ to `:default' encoding. If it fails, return S." ;;`org-export-stack-remove', `org-export-stack-view' and ;;`org-export-stack-clear'. ;; -;; For back-ends, `org-export-add-to-stack' add a new source to stack. +;; For backends, `org-export-add-to-stack' add a new source to stack. ;; It should be used whenever `org-export-async-start' is called. (defun org-export-async-start (fun body) @@ -6717,9 +6717,9 @@ and `org-export-to-file' for more specialized functions." post-process) "Call `org-export-as' with output to a specified buffer. -BACKEND is either an export back-end, as returned by, e.g., +BACKEND is either an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. +a registered backend. BUFFER is the name of the output buffer. If it already exists, it will be erased first, otherwise, it will be created. @@ -6736,7 +6736,7 @@ see. Optional argument POST-PROCESS is a function which should accept no argument. It is always called within the current process, -from BUFFER, with point at its beginning. Export back-ends can +from BUFFER, with point at its beginning. Export backends can use it to set a major mode there, e.g., (defun org-latex-export-as-latex @@ -6786,9 +6786,9 @@ This function returns BUFFER." post-process) "Call `org-export-as' with output to a specified file. -BACKEND is either an export back-end, as returned by, e.g., +BACKEND is either an export backend, as returned by, e.g., `org-export-create-backend', or a symbol referring to -a registered back-end. FILE is the name of the output file, as +a registered backend. FILE is the name of the output file, as a string. A non-nil optional argument ASYNC means the process should happen @@ -6801,7 +6801,7 @@ see. Optional argument POST-PROCESS is called with FILE as its argument and happens asynchronously when ASYNC is non-nil. It -has to return a file name, or nil. Export back-ends can use this +has to return a file name, or nil. Export backends can use this to send the output file through additional processing, e.g, (defun org-latex-export-to-latex @@ -6905,7 +6905,7 @@ Return file name as a string." "Add a new result to export stack if not present already. SOURCE is a buffer or a file name containing export results. -BACKEND is a symbol representing export back-end used to generate +BACKEND is a symbol representing export backend used to generate it. Entries already pointing to SOURCE and unavailable entries are @@ -6988,7 +6988,7 @@ or buffers, only display. \\{org-export-stack-mode-map}" (setq tabulated-list-format (vector (list "#" 4 #'org-export--stack-num-predicate) - (list "Back-End" 12 t) + (list "Backend" 12 t) (list "Age" 6 nil) (list "Source" 0 nil))) (setq tabulated-list-sort-key (cons "#" nil)) @@ -7021,7 +7021,7 @@ appropriate for `tabulated-list-print'." (vector ;; Counter. (number-to-string (cl-incf counter)) - ;; Back-End. + ;; Backend. (if (nth 1 entry) (symbol-name (nth 1 entry)) "") ;; Age. (let ((info (nth 2 entry))) @@ -7170,7 +7170,7 @@ back to standard interface." ;; Fontify VALUE string. (propertize value 'face 'font-lock-variable-name-face))) ;; Prepare menu entries by extracting them from registered - ;; back-ends and sorting them by access key and by ordinal, + ;; backends and sorting them by access key and by ordinal, ;; if any. (entries (sort (sort (delq nil @@ -7222,7 +7222,7 @@ back to standard interface." (funcall fontify-key "C-a" t) (funcall fontify-value (if (memq 'async options) "On " "Off"))) - ;; Display registered back-end entries. When a key + ;; Display registered backend entries. When a key ;; appears for the second time, do not create another ;; entry, but append its sub-menu to existing menu. (let (last-key) diff --git a/testing/lisp/test-org-element.el b/testing/lisp/test-org-element.el index 6f95b0f0a..daa1fea2c 100644 --- a/testing/lisp/test-org-element.el +++ b/testing/lisp/test-org-element.el @@ -1041,8 +1041,8 @@ Some other text "Test `export-snippet' parser." (should (equal - '("back-end" . "contents") - (org-test-with-temp-text "@@back-end:contents@@" + '("backend" . "contents") + (org-test-with-temp-text "@@backend:contents@@" (org-element-map (org-element-parse-buffer) 'export-snippet (lambda (snippet) (cons (org-element-property :back-end snippet) @@ -3378,8 +3378,8 @@ DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu (ert-deftest test-org-element/export-snippet-interpreter () "Test export snippet interpreter." - (should (equal (org-test-parse-and-interpret "@@back-end:contents@@") - "@@back-end:contents@@\n"))) + (should (equal (org-test-parse-and-interpret "@@backend:contents@@") + "@@backend:contents@@\n"))) (ert-deftest test-org-element/footnote-reference-interpreter () "Test footnote reference interpreter." diff --git a/testing/lisp/test-ox.el b/testing/lisp/test-ox.el index 99f5c0f0f..33d9ee669 100644 --- a/testing/lisp/test-ox.el +++ b/testing/lisp/test-ox.el @@ -26,8 +26,8 @@ (require 'org-inlinetask) (defun org-test-default-backend () - "Return a default export back-end. -This back-end simply returns parsed data as Org syntax." + "Return a default export backend. +This backend simply returns parsed data as Org syntax." (org-export-create-backend :transcoders (mapcar (lambda (type) @@ -181,7 +181,7 @@ num:2 <:active"))) (eq (plist-get options :section-numbers) 2) (eq (plist-get options :with-timestamps) 'active) (equal (plist-get options :with-drawers) '("TEST"))))) - ;; Test back-end specific values. + ;; Test backend specific values. (should (equal (org-export--parse-option-keyword @@ -214,18 +214,18 @@ num:2 <:active"))) ;; Test `space' behaviour. (should (equal - (let ((back-end (org-export-create-backend + (let ((backend (org-export-create-backend :options '((:keyword "KEYWORD" nil nil space))))) (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: spaces" - (org-export--get-inbuffer-options back-end))) + (org-export--get-inbuffer-options backend))) '(:keyword "With spaces"))) ;; Test `newline' behaviour. (should (equal - (let ((back-end (org-export-create-backend + (let ((backend (org-export-create-backend :options '((:keyword "KEYWORD" nil nil newline))))) (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: two lines" - (org-export--get-inbuffer-options back-end))) + (org-export--get-inbuffer-options backend))) '(:keyword "With\ntwo lines"))) ;; Test `split' behaviour. (should @@ -1853,10 +1853,10 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] -;;; Back-End Tools +;;; Backend Tools (ert-deftest test-org-export/define-backend () - "Test back-end definition and accessors." + "Test backend definition and accessors." ;; Translate table. (should (equal '((headline . my-headline-test)) @@ -1890,7 +1890,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (ert-deftest test-org-export/define-derived-backend () "Test `org-export-define-derived-backend' specifications." - ;; Error when parent back-end is not defined. + ;; Error when parent backend is not defined. (should-error (let (org-export-registered-backends) (org-export-define-derived-backend 'test 'parent))) @@ -1956,7 +1956,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (ert-deftest test-org-export/get-all-transcoders () "Test `org-export-get-all-transcoders' specifications." - ;; Return nil when back-end cannot be found. + ;; Return nil when backend cannot be found. (should-not (org-export-get-all-transcoders nil)) ;; Same as `org-export-transcoders' if no parent. (should @@ -1981,7 +1981,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (org-export-get-all-transcoders (org-export-create-backend :parent 'b2 :transcoders '((paragraph . ignore))))))) - ;; Back-end transcoders overrule inherited ones. + ;; Backend transcoders overrule inherited ones. (should (eq 'b (let (org-export-registered-backends) @@ -1993,7 +1993,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (ert-deftest test-org-export/get-all-options () "Test `org-export-get-all-options' specifications." - ;; Return nil when back-end cannot be found. + ;; Return nil when backend cannot be found. (should-not (org-export-get-all-options nil)) ;; Same as `org-export-options' if no parent. (should @@ -2018,7 +2018,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (org-export-get-all-options (org-export-create-backend :parent 'b2 :options '((:key3 value3))))))) - ;; Back-end options overrule inherited ones. + ;; Backend options overrule inherited ones. (should (eq 'b (let (org-export-registered-backends) @@ -2030,7 +2030,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (ert-deftest test-org-export/get-all-filters () "Test `org-export-get-all-filters' specifications." - ;; Return nil when back-end cannot be found. + ;; Return nil when backend cannot be found. (should-not (org-export-get-all-filters nil)) ;; Same as `org-export-filters' if no parent. (should @@ -2059,7 +2059,7 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (org-export-get-all-filters (org-export-create-backend :parent 'b2 :filters '((:filter-paragraph . ignore))))))) - ;; Back-end filters overrule inherited ones. + ;; Backend filters overrule inherited ones. (should (eq 'b (let (org-export-registered-backends) @@ -2071,9 +2071,9 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (ert-deftest test-org-export/with-backend () "Test `org-export-with-backend' definition." - ;; Error when calling an undefined back-end + ;; Error when calling an undefined backend (should-error (org-export-with-backend nil "Test")) - ;; Error when called back-end doesn't have an appropriate + ;; Error when called backend doesn't have an appropriate ;; transcoder. (should-error (org-export-with-backend @@ -2095,11 +2095,11 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (org-export-create-backend :transcoders '((plain-text . (lambda (text info) "Success")))) "Test"))) - ;; Provide correct back-end if transcoder needs to use recursive + ;; Provide correct backend if transcoder needs to use recursive ;; calls. (should (equal "Success\n" - (let ((test-back-end + (let ((test-backend (org-export-create-backend :transcoders (list (cons 'headline @@ -2115,13 +2115,13 @@ Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote] (list (cons 'headline (lambda (headline contents info) (org-export-with-backend - test-back-end headline contents info)))))))))) + test-backend headline contents info)))))))))) (ert-deftest test-org-export/data-with-backend () "Test `org-export-data-with-backend' specifications." - ;; Error when calling an undefined back-end. + ;; Error when calling an undefined backend. (should-error (org-export-data-with-backend nil "nil" nil)) - ;; Otherwise, export data recursively, using correct back-end. + ;; Otherwise, export data recursively, using correct backend. (should (equal "Success!" @@ -3107,7 +3107,7 @@ Para2" (link . (lambda (l c i) (or (org-export-custom-protocol-maybe l c 'no-test i) "failure"))))))))) - ;; Ignore anonymous back-ends. + ;; Ignore anonymous backends. (should-not (string-match "success" @@ -3835,7 +3835,7 @@ Another text. (ref:text) (let ((headline (org-element-map tree 'headline #'identity nil t))) (equal (org-export-get-reference headline info) (org-export-get-reference headline info))))) - ;; References get through local export back-ends. + ;; References get through local export backends. (should (org-test-with-parsed-data "* Headline" (let ((headline (org-element-map tree 'headline #'identity nil t))