## Home

help (3)

This is ReText wiki.

Some useful pages:

## FAQ

#### For which platforms is ReText available?

ReText is officially supported on Linux.

For the Mac, there is a Homebrew tap at https://github.com/samueljohn/homebrew-python

brew tap samueljohn/python
brew install enchant
pip install pyenchant
pip install markups
pip install markdown2
pip install docutils
brew install retext


Theoretically it can be run on any other platform. If you want to port ReText to your platform, please contact Dmitry (mitya57 (at) gmail.com).

#### Why is ReText better than my favourite text editor (Gedit, KWrite)?

It supports text formatting and can save to different file formats (PDF, HTML).

#### Why is ReText better than my favourite word processor (LibreOffice Writer, KWord, AbiWord)?

Most word processors are very complicated. Also, they leave much mess in the output files. ReText gives you a power to control all your formatting. Markdown and reST are WYSIWYM markup languages, so if you save your document as plain text, everyone will see where the formarring goes. Also, ReText has tabs support.

#### What are Markdown and reStructuredText?

Markdown is a text markup language which allows you to create documents of all types (this page is written using Markdown). Some links: website, sourceforge.net guide, basics, syntax, and online renderer.

You may also have a look at ODT to Markdown convertion script (details).

reStructuredText is another popular markup language. Some links: website, quick reference, example document, cheat sheet, and online renderer.

#### Can I use page breaks?

Yes, you can do this in Markdown mode by using "page-break-before: always" style. Example:

Some text here.

Another page starts here.
{: style="page-break-before: always" }


You should enable attr_list Markdown extension before using this (see Configuration file for details).

#### I want to translate ReText into my language.

You are welcome!
There are two ways to translate ReText. First one is via Transifex web interface.

Also, you can translate .ts files manually using Qt Linguist. Here are the instructions:

• Install Qt4 and PyQt4 dev tools (On Ubuntu you need packages qt4-dev-tools, pyqt4-dev-tools, libqt4-dev)
• Get the code (i.e. via Git) and go to its directory
• Run pylupdate4 retext.py -ts retext_%LANG%.ts (replace %LANG% with code of your language, i.e. retext_fr.ts or retext_pt_BR.ts)
• Open the generated .ts file with Qt Linguist and make the translation (you can read the one minute guide first)
• Create a ticket and attach the .ts file there so that we can include it to ReText source code tree
• Until that, you can compile the translation into a .qm file via Qt Linguist and use it.

1 2 3 > >> (Page 1 of 3)

• Dmitry Shachnev
2011-03-27

This is an interesting idea, but I'm not sure if it's easy to implement.

Last edit: Dmitry Shachnev 2011-05-29

• Dmitry Shachnev
2011-04-05

No, it's Qt restriction.

• Anonymous
2011-06-14

Is it possible to add a menu entry (and keyboard shortcut ideally) to show/hide the button bar? I (like many now) am trying for as minimal a desktop as possible to reduce distractions. Since I don't use any of those buttons (copy, paste, etc.) I'd like to be able to hide the bar.

• Dmitry Shachnev
2011-06-19

You can right-click the toolbar and uncheck the "File toolbar" and "Edit toolbar" items.

To enable them back, right-click on the menu and check them back.

You can also hide all the toolbars and the menubar using Shift+F12 shortcut (warning: this disables all the other keyboard shortcuts, you'll need to press Shift+F12 again to be able to save the file).

• Anonymous
2011-06-21

This is possibly my favourite program, so thanks :-)

I'd like to change the font size in the text editor. Is this possible?

Leon

• Dmitry Shachnev
2011-07-06

Commited to Git!

Use editorFontSize setting in the configuration file.

• MarioZaizar
2011-08-09

Note: right now it's possible to install ReText on Mac OSX Lion.
You just need install: Python-Markdown~2.0, PyQT-Mac~4.8, Sip~4.12.

After that you could run the app, but seems like the icons are not being rendered.
Here is an screenshoot: http://cl.ly/2h2E2f3b3z2R3e410T1k

May we have some fixes to that specific OSX issues?
- Mario

• Dmitry Shachnev
2011-09-03

Hi! You should download the icons pack and extract it into icons sub-directory of your ReText installation directory.

Last edit: Dmitry Shachnev 2011-09-03

• Anonymous
2012-08-13

I'd like to try my hand at creating a Homebrew recipe for this.

• Anonymous
2011-08-30

Hi,
This is a wonderful piece of software. Would it be possible to use pandoc (http://johnmacfarlane.net/pandoc/) directly to parse the markdown content into HTML...? You suggest using pandoc to export to various formats. I was thinking of using it directly to parse the markdown source. This would allow including mathematical equations using MathJax (http://www.mathjax.org/) in the documents ans also allow to export to Latex for instance.

--Vijay

• Dmitry Shachnev
2011-09-03

Qt doesn't allow displaying equations in a QTextEdit widget. But you can use pandoc to export to different formats.

To use it, you need to add a section "Export" to your config file like this:

[Export]
rtf=/usr/bin/pandoc -f markdown -t rtf -o %of %if
docbook=/usr/bin/pandoc -f markdown -t docbook -o %of %if


where %of and %if will be replaced with input and output filenames at runtime.

Then you can access this feature via "Export > Other formats". Note: format name should be the same as the extension, since it's appended to the filename.

Last edit: Dmitry Shachnev 2011-09-03

• Anonymous
2011-11-08

Dmitry, I just found ReText and I like it very much. I only really miss MathJax. I saw that WebKit support was added only recently -- will you enable javascript support?

• Dmitry Shachnev
2011-11-12

WebKit engine supports JavaScript. You can enable it by adding useWebKit=true to your configuration file.

<a onclick="alert('This is JS alert!')">Click here</a>


• Anonymous
2012-01-03

Hi there!

Is it possible to implement something like gedit´s external tools? My programming skills are very basic but it would be very useful in order to add some particular features for professional copywriters like me.
I.E. Several online dictionary look ups, text snippets for automating markup, natural language coulored syntax... Custom shortcuts...

I'd be glad sharing ideas... If you want to...

PS. Excuse my language if I made some mistake... English isn't my first or second language :P

Last edit: Dmitry Shachnev 2012-01-13

• Dmitry Shachnev
2012-01-13

Syntax highlighting and shortcuts for bold/italics/underlined text are already in git version (which will become 3.0).

Also, we'll have export extensions there, some other can follow (i.e. actions on selected text).

Are snippets really needed for Markdown/reST (any examples)? I though tags/symbols boxes are enough for that.

• Anonymous
2012-01-29

I'm spanish and when I try to type an vowel with accent (á, é, í, ó, ú) get the accent and the vowel sepparated, like 'a, 'e, 'i, 'o and 'u. I must copy-paste the text which is not practical. Is it a bug? Am I missing something?

• Dmitry Shachnev
2012-01-30

How do you type such characters? I entered Compose +  + a and got a correct "á" character. I have Qt 4.7.4 installed. If you have problems with the same (or newer) version, please report a bug to Qt bug tracker.

• Anonymous
2012-02-10

Any chance of adding syntax highlighting to ReText?

• Dmitry Shachnev
2012-02-10

Syntax highlighting is already implemented in Git, and will be available in ReText 3.0 (we are planning to release beta 1 very soon).

• Anonymous
2012-04-27

Great! I really like the live preview. But I prefer (py)textile over markdown. It allows to add CSS class and id identifiers. So I made a quick hack and changed

 md=markdown.Markdown()   => md=textile


and

md.reset()
return md.convert(htmltext)  => md.textile(htmltext)
`

and it basically works.

Would "official" support of textile be a possibility?

• Dmitry Shachnev
2012-04-28

Looks interesting! I will add support for that in next major release.

[Update: see my comment below]

Last edit: Dmitry Shachnev 2012-07-27

• Anonymous
2012-04-29

Cool! Thank you!!

• Dmitry Shachnev
2012-07-27

Python-Textile project seems to be unmaintained, they don't even review pull requests... We won't be able to add textile support until they merge the pull request that adds python3 support.

• Anonymous
2012-05-17

Great program and excellent documentation. You have a small typo on this page, though, that is breaking a link. The link to the Wikipedia page for "WYSIWYM" actually points to "WYSIMYM", which doesn't exist.

• Dmitry Shachnev
2012-05-31