Add CodeChat: the ability to transform source code into HTML in the Preview dock

[bjones1]

First, pip install CodeChat before testing. Then, you'll need to enable it using Settings | Options | CodeChat | Enable.

This makes it much easier to see any reST markup in a given source file; the preview module and its associated test provide a good example.

[andreikop]

Hi Sorry for not being able to merge it during last days. Will try to do it asup. @bjones1 , have you seen 2 issues in your issue tracker?

[bjones1]

Andrei,

No problem, thanks for the update. Moving is lots of work :).

I'm embarrassed to say, I haven't seen the issues (until now) -- I had e-mail notifications turned off. I'll work on them! One is already done, I just need to create a pull request.

[andreikop]

@bjones1, could you please

• add CodeChat installation instructions to the REAME
• add CodeChat installation instructions to the settings page. We might show it if CodeChat is not installed

I'll add installation instructions to http://enki-editor.org/install-sources.html

Settings page explains, what is CodeChat, but not what exactly user will see. New user might not understand, that Preview==CodeChat. Maybe we could add to settings page something like CodeChat shows literate representation of your file on Preview dock

[andreikop]

I've rebased the branch to the latest master and added a fix, which makes settings tree better aligned. See hlamer/CodechatRst

[andreikop]

The tool works fine! Looking forward for a fixes to merge it to the upstream

[bjones1]

Great! Working on it now. Rather than include install instruction in README.md, I put a link to CodeChat and will provide install instructions there, following the pattern for the other dependencies in README.md.

[bjones1]

@hlamer : would you take a look now? I believe I've address all the issues you raised.

[andreikop]

Merged! Thanks

Will be released with next version.

Some notes:

• You added codechat.png to the repository. It probably was going to be the settings page icon. I set it as the icon.
• I highlighted CodeChat not installed message with red on the settings page.
• https://bitbucket.org/bjones/documentation/overview doesn't contain install instructions. Probably you can add something like
  1. Clone with command ...
  2. Install with python ./setup.py install
• Since CodeChat is pure-python and optional for Enki, I think it is acceptable to install it from PyPI. And creating PyPI package should be much easier, than .deb and .rpm

[bjones1]

Great!

Adding codechat.png was a mistake on my part; it's the default PyInstaller icon, not anything that really represents CodeChat. Therefore, I'll submit a pull request to remove it.

I'll add install instructions -- thanks for reminding me to do this.

I agree that installing CodeChat from PyPI is much easier. However, is it possible to do that when installing Enki on Linux using a package manager? I thought external network access when doing an apt-get install / zypper install wasn't allowed.

[andreikop]

I agree that installing CodeChat from PyPI is much easier. However, is it possible to do that when installing Enki on Linux using a package manager? I thought external network access when doing an apt-get install / zypper install wasn't allowed.

Yes, not allowed. However, if Enki starts without it and gently notifies user, what is wrong, he can install CodeChat manually. Of course .deb and .rpm package would be better.

— Reply to this email directly or view it on GitHub https://github.com/hlamer/enki/pull/209#issuecomment-45637582.

[bjones1]

OK, that makes sense. I'll certainly target .deb/.rpm packages, so that installation will be easier. For now, good instructions for PyPI will certainly help.