Warning, /office/kile/README.cwl is written in an unsupported language. File is not indexed.
0001 CWL File Specification 0.1: 0002 0003 Completion modes: 0004 Kile supports three completion modes, which use their own cwl files: 0005 - (La)TeX mode 0006 - Dictionary mode 0007 - Abbreviation mode 0008 0009 Call of completion: 0010 When completion is called with a shortcut or in auto mode, Kile must separate words, so that some restriction had to be made about the already typed prefix. If the prefix is to be analyzed as valid, the completion box will open, otherwise not. 0011 - (La)TeX mode: all prefixes must start with a backslash, followed by letters, possibly with a trailing star 0012 - Dictionary mode: letters, digits and underscore are valid characters 0013 - Abbreviation mode: letters, digits and underscore are valid characters 0014 Once the completion box is opened, there are no further restrictions. All characters are valid from this moment on. 0015 0016 Naming scheme of the cwl file: 0017 - If the commands in the file belong to a class the name is class-foo.cwl, if they belong to different classes the name is class-foo,bar.cwl. 0018 - In any other case it belongs to a package and should therefore have the same name than the package (package foo -> foo.cwl) 0019 0020 File syntax: 0021 - There are only two types of content, comments and text. 0022 - Comments start with a #, everything after # is ignored till the end of the line. 0023 - Everything else is text. 0024 0025 File content: 0026 - The files should have a small header including your name (email address is not needed), the date, and a link where the package or the class file can be downloaded. 0027 For example the header of textcomp.cwl: 0028 # textcomp package 0029 # tbraun 04/27/2006 0030 # URL: http://www.ctan.org/tex-archive/help/Catalogue/entries/textcomp.html 0031 - All commands given must have a description what to insert in the empty brackets: 0032 -- \label{key} and not \label{} 0033 -- \includegraphics[options]{name} 0034 -- \footnotetext[number]{text} and so on 0035 - All commands means all commands. So please add all possible combinations, including mandatory options and all optional options in all possible combinations. 0036 This list can be quite long but all users will appreciate the completeness. 0037 For example (taken from class-beamer.cwl): 0038 \begin{frame} 0039 \begin{frame}<overlay specification> 0040 \begin{frame}<overlay specification>[<default overlay specification>] 0041 \begin{frame}<overlay specification>[<default overlay specification>][options] 0042 \begin{frame}<overlay specification>[<default overlay specification>][options]{title} 0043 \begin{frame}<overlay specification>[<default overlay specification>][options]{title}{subtitle} 0044 \begin{frame}[<default overlay specification>] 0045 \begin{frame}[<default overlay specification>][options] 0046 \begin{frame}[<default overlay specification>][options]{title} 0047 \begin{frame}[<default overlay specification>][options]{title}{subtitle} 0048 \begin{frame}[<default overlay specification>][options]{title}{subtitle} 0049 \begin{frame}[options] 0050 \begin{frame}[options]{title} 0051 \begin{frame}[options]{title}{subtitle} 0052 \begin{frame}[options]{title}{subtitle} 0053 \begin{frame}{title} 0054 \begin{frame}{subtitle} 0055 \end{frame} 0056 - Only include the \end{env} command once, but all combinations with \begin{env}{}[]<>... 0057 - If you declare an environment in which the \item command is valid you have to suffix the \begin{...} declaration with \item, like in latex-document.cwl \begin{itemize}\item. 0058 - A starred version of a command must also be added 0059 \circle{diameter} 0060 \circle*{diameter} 0061 0062 Getting assistance: 0063 - You can see some examples under http://projects.kde.org/projects/extragear/office/kile/repository/revisions/master/show/src/data/complete/tex 0064 - If in doubt don't hesitate to mail to kile-devel@lists.sourceforge.net and ask, we will be glad to help you :) 0065 0066 The Kile development team