Hi James, James Cook <falsif...@falsifian.org> writes:
> Oops, I missed the reference to TeX-expand-list. Thanks for your > response. > > It might help to mention the existence of placeholders more > prominently. E.g. by inserting this sentence: > > Placeholders in the strings are expanded as defined in > `TeX-expand-list`. > > immediately after the sentence > > The command line can either be specified as a single string or a list > of strings and two-part lists. > > Adding an example would also help. this report went lost in action, sorry for that. I'd like to propose this change in order to fix and close this issue; the patch is more complicated to read because of the re-filling, but I hope you get the point. As a note, I'm not sure if an example in the docstring makes things more clear, therefore I add a reference to `TeX-view-program-list-builtin' for examples: --8<---------------cut here---------------start------------->8--- diff --git a/tex.el b/tex.el index ea688f17..503072a5 100644 --- a/tex.el +++ b/tex.el @@ -1376,38 +1376,37 @@ description of the data format.") (defcustom TeX-view-program-list nil "List of viewer specifications. -This variable can be used to specify how a viewer is to be -invoked and thereby add new viewers on top of the built-in list -of viewers defined in `TeX-view-program-list-builtin' or override -entries in the latter. - -The car of each item is a string with a user-readable name. The -second element can be a command line to be run as a process or a -Lisp function to be executed. The command line can either be -specified as a single string or a list of strings and two-part -lists. The first element of the two-part lists is a symbol or a -list of symbols referring to one or more of the predicates in -`TeX-view-predicate-list' or `TeX-view-predicate-list-builtin'. -The second part of the two-part lists is a command line part. -The command line for the viewer is constructed by concatenating -the command line parts. Parts with a predicate are only -considered if the predicate was evaluated with a positive result. -Note that the command line can contain placeholders as defined in -`TeX-expand-list' which are expanded before the viewer is called. -The third element of the item is optional and is a string, or a -list of strings, with the name of the executable, or executables, -needed to open the output file in the viewer. Placeholders -defined in `TeX-expand-list' can be used here. This element is -used to check whether the viewer is actually available on the -system. - -The use of a function as the second element only works if the -View command in `TeX-command-list' makes use of the hook +This variable can be used to specify how a viewer is to be invoked and +thereby add new viewers on top of the built-in list of viewers defined +in `TeX-view-program-list-builtin' or override entries in the latter +which also serves as an example for usage. + +The car of each item is a string with a user-readable name. The second +element can be a command line to be run as a process or a Lisp function +to be executed. The command line can either be specified as a single +string or a list of strings and two-part lists. The first element of +the two-part lists is a symbol or a list of symbols referring to one or +more of the predicates in `TeX-view-predicate-list' or +`TeX-view-predicate-list-builtin'. The second part of the two-part +lists is a command line part. The command line for the viewer is +constructed by concatenating the command line parts. Parts with a +predicate are only considered if the predicate was evaluated with a +positive result. Note that the command line can contain placeholders as +defined in the variable `TeX-expand-list' or in +`TeX-expand-list-builtin' which are expanded before the viewer is +called. The third element of the item is optional and is a string, or a +list of strings, with the name of the executable, or executables, needed +to open the output file in the viewer. Placeholders defined in the +variable `TeX-expand-list' or in `TeX-expand-list-builtin' can be used +here. This element is used to check whether the viewer is actually +available on the system. + +The use of a function as the second element only works if the View +command in `TeX-command-list' makes use of the hook `TeX-run-discard-or-function'. -Note: Predicates defined in the current Emacs session will only -show up in the customization interface for this variable after -restarting Emacs." +Note: Predicates defined in the current Emacs session will only show up +in the customization interface for this variable after restarting Emacs." :group 'TeX-view :type `(repeat --8<---------------cut here---------------end--------------->8--- Any comments welcome. Best, Arash _______________________________________________ bug-auctex mailing list bug-auctex@gnu.org https://lists.gnu.org/mailman/listinfo/bug-auctex
