3,897
edits
Changes
Jump to navigation
Jump to search
no edit summary
<cd:commandgroup name="ReadFile" xmlns:cd="http://wiki.contextgarden.net/commanddoc/20200807">
<cd:shortdesc><!-- a short command summary goes here -->
The command <tt>\ReadFile</tt> is used for ...includes an external file
</cd:shortdesc>
<cd:variants>
<cd:keywords delimiters="braces" ordinal="1">
<cd:keywordsdoc></cd:keywordsdoc>
<cd:constant type="cd:file">name of the file</cd:constant>
</cd:keywords>
</cd:arguments>
</cd:command>
</cd:variants>
<cd:description>The command <code>\ReadFile {filename}<!-- /code> is replaced by the long description content of the command goes here --text file <code>filename</code>, if it exists. If it does not exist, no error message is generated and the compile process continues. When no file extension is specified, the extension <code>.tex</code>is assumed. Similar to the case with project structure commands such as {{cmd|environment}}, {{cmd|ReadFile}} causes ConTeXt to look in ancestor directories for the specified file.
</cd:description>
<cd:examples><cd:example title="">We have a chapter 1 file, but no chapter 2 file:<texcode>% chapter-01.tex\subject{Chapter 1} This is the first chapter.</texcode> The book file attempts to incorporate both chapters, using <code>\ReadFile{filename}</code>:<texcode>% complete-book.tex\starttext % No extension specified, so .tex assumed\ReadFile{chapter-01}\ReadFile{chapter-02} \stoptext</texcode> Compiling <code>book.tex</code> produces the following:<context>\subject{Chapter 1} This is the first chapter.</context> No error message is generated for the missing chapter 2, and the compilation completes successfully.</cd:example></cd:examples>
<cd:notes></cd:notes>
<cd:seealso>
<cd:source file="file-res.mkvi" originator="system"></cd:source>
<cd:wikipage originator="system" page="Category:Structure"></cd:wikipage><cd:commandref name="input">Similar to <code>\ReadFile</code> but the filename is not specified as an argument.</cd:commandref><cd:commandref name="readfile">Similar to <code>\ReadFile</code> with additional options when file is not found.</cd:commandref><cd:commandref name="getbuffer">Get back the "formatted" content of a buffer. </cd:commandref></cd:seealso>
</cd:commandgroup>
