Search wiki: labels_t:"help"


Export Extensions (WikiPage)
Export Extensions were introduced in ReText 3.0 and allow you to add your own export functions to ReText. The specification Basics An export extension is a desktop-file located in RETEXT_PREFIX/share/retext/export-extensions, currently supported prefixes are /usr and ~/.local. Export extension file should have a .desktop extension. It is possible to write extensions that are compatible with the Desktop Entry Specification. Export extensions take Markdown, ReST or HTML files as input file. Structure of the file Here's a basic file structure: [Desktop entry] # First line is optional Key1=Value1 Key2=Value2 ... Supported keys Currently supported keys are Name, Name[locale], Icon, Exec, MimeType, FileFilter and DefaultExtension. Keys Exec, FileFilter and DefaultExtension may have a X-ReText- vendor prefix. Key Description Name, Name[locale] Displayed name of the extension, with possible localizations Icon Name of the icon in the icon theme Exec Absolute path to command being executed, with some arguments (see section below) MimeType When set, the extension will be enabled with a certain file type. Use text/x-{retext-}markdown, text/x-{retext-}rst or text/html here. FileFilter Used in save dialog, should be in form of QFileDialog file filter (example: Filter 1 (*.ext11 *.ext12);;Filter 2 (*.ext2)) DefaultExtension Default extension that dialog will append to the file (example: .ext) Command arguments These arguments, if given in Exec key string, ReText will replace: Argument Replaced with %if Input file name (Markdown or ReST) %html Input HTML file name %of Output file name (will trigger a dialog to allow user select one) Example of extension This extension will use pandoc to export a Markdown file to RTF [Desktop Entry] Name=Export to RTF Name[ru]=Экспорт в RTF Exec=/usr/bin/pandoc -f markdown -t rtf -o %of %if X-ReText-FileFilter=RTF Files (*.rtf) X-ReText-DefaultExtension=.rtf
Last updated: 2014-11-15

Quick Start Guide (WikiPage)
This is a quick guide for starting to work with ReText. System Requirements Any modern operating system Python 3.x Qt 5 libraries PyQt bindings PyMarkups Python-Markdown and/or Docutils This component is needed if you want to use some extra features: PyEnchant - for spell checking support Debian users can find ReText in their testing repository, and Ubuntu users can install it from ppa:mitya57. Users of other systems can download ReText from the Downloads page. Users of non-X11 systems should also download the icons pack and extract it into icons sub-directory of ReText installation directory. Starting up After you open ReText, the main editing area will be shown. You can now type the text in your favourite markup language. You can switch between Markdown and ReStructuredText using "Edit → Default editing mode" menu (if both modules are installed). For preview, click "Preview" button or press Ctrl+E. To enable two-panel mode, activate "Live Preview" from "Edit" menu or press Ctrl+L. To insert a page break, look at this page. To see pages layout, use "File → Print Preview" menu option. To set a font, use "Edit → Change default font" option. Files are opened and saved just like in all other text editors. To export a file to a different format, use "File → Export" menu. Next steps Look at our Webpages Generator guide or learn how to tune ReText using the configuration file.
Last updated: 2015-03-09

Showing 2 results of 2

Sort by relevance or date

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:

No, thanks