Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 31 additions & 27 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,19 @@ CodeChat Editor. If not, see
[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).

Changelog
================================================================================
=========

[Github master](https://github.com/bjones1/CodeChat_Editor)
--------------------------------------------------------------------------------
-----------------------------------------------------------

* No changes.
* First and second-level heading underlines are now sized based on the heading's
length, rather than fixed at 80 characters.
* Update to latest version of CodeMirror, graphviz, ts-rs, pdfjs,
notify-deboucer, dprint-markdown, Rust. Improved CodeMirror means removal of a
patch to CodeMirror source.

Version 0.1.49 -- 2025-Dec-29
--------------------------------------------------------------------------------
-----------------------------

* Added instructional videos to manual.
* Improve accessibility by using content sectioning tags.
Expand All @@ -35,7 +39,7 @@ Version 0.1.49 -- 2025-Dec-29
form after a re-translation in the Client.

Version 0.1.48 -- 2025-Dec-22
--------------------------------------------------------------------------------
-----------------------------

* Re-translate Markdown documents as necessary. This causes math written in the
Client to immediately be rendered, instead of needing to switch to the IDE and
Expand All @@ -47,7 +51,7 @@ Version 0.1.48 -- 2025-Dec-22
the Client edits didn't update IDE text.

Version 0.1.47 -- 2025-Dec-19
--------------------------------------------------------------------------------
-----------------------------

* Fix errors in Client when editing a file with adjacent doc blocks.
* Fix out of sync errors when the table of contents file is open.
Expand All @@ -63,14 +67,14 @@ Version 0.1.47 -- 2025-Dec-19
[Loci](https://www.simcenter.msstate.edu/software/luke/loci/index.html) files.

Version 0.1.46 -- 2025-Dec-15
--------------------------------------------------------------------------------
-----------------------------

* Avoid spaces disappearing in Client when editing lists.
* Improve speed of convert
* Improve Client error reporting.

Version 0.1.45 -- 2025-Dec-11
--------------------------------------------------------------------------------
-----------------------------

* Fix loss of editing in the Client when in document-only mode.
* Fix data corruption in the Client when in document-only mode and edits are
Expand All @@ -80,7 +84,7 @@ Version 0.1.45 -- 2025-Dec-11
* Correctly translate table cells containing blocks from HTML to Markdown.

Version 0.1.44 -- 2025-Dec-09
--------------------------------------------------------------------------------
-----------------------------

* Update Graphviz to latest build; make Graphviz output a block element, not an
inline element.
Expand All @@ -93,13 +97,13 @@ Version 0.1.44 -- 2025-Dec-09
* Correct incorrect whitespace removal in Graphviz and Mermaid diagrams.

Version 0.1.43 -- 2025-Dec-05
--------------------------------------------------------------------------------
-----------------------------

* Fix cursor movement errors in the Client.
* Prevent unnecessary saves of Client data to the IDE.

Version 0.1.42 -- 2025-Dec-04
--------------------------------------------------------------------------------
-----------------------------

* Drag and drop of images creates a mess; disable drop and drop for this reason.
* Send sync data when doc blocks receive focus.
Expand All @@ -114,7 +118,7 @@ Version 0.1.42 -- 2025-Dec-04
* Increase time errors messages are displayed in the Client.

Version 0.1.41 -- 2025-Nov-17
--------------------------------------------------------------------------------
-----------------------------

* Math now renders in the active doc block, as shown below.
* Math is now protected from accidental edits in the Client:
Expand All @@ -125,23 +129,23 @@ Version 0.1.41 -- 2025-Nov-17
* Remove unnecessary TinyMCE plugins.

Version 0.1.40 -- 2025-Nov-11
--------------------------------------------------------------------------------
-----------------------------

* File watcher now accepts new files from the Client.
* Improved translation from HTML to Markdown.
* Build correct binary for Mac M1.
* Add CodeMirror support for SQL and YAML.

Version 0.1.39 -- 2025-Oct-23
--------------------------------------------------------------------------------
-----------------------------

* Scroll viewport to center on cursor movement.
* Significant improvements to test framework.
* Improved build framework.
* Refactor IDE interface back into the Server.

Version 0.1.38 -- 2025-Sep-24
--------------------------------------------------------------------------------
-----------------------------

* Automatically find a free port for the Client, instead of requiring the user
to specify it in the VSCode settings.
Expand All @@ -152,14 +156,14 @@ Version 0.1.38 -- 2025-Sep-24
* Improved build process.

Version 0.1.37 -- 2025-Sep-22
--------------------------------------------------------------------------------
-----------------------------

* Fix: avoid loading the same file twice in a row when the user clicks on a link
in the Client.
* Improve VSCode connection with the Server.

Version 0.1.36 -- 2025-Sep-17
--------------------------------------------------------------------------------
-----------------------------

* The system continues to work after a PC goes to sleep then wakes back up;
communication within previous versions fails after a sleep/wake up cycle.
Expand All @@ -171,21 +175,21 @@ Version 0.1.36 -- 2025-Sep-17
* Remove the File entry from the HTML editor's main menu.

Version 0.1.35 -- 2025-Sep-12
--------------------------------------------------------------------------------
-----------------------------

* Embed the CodeChat Editor Server inside the VSCode extension, rather than
running it as a standalone binary.
* Fixes to the build process.

Version 0.1.34 -- 2025-Sep-08
--------------------------------------------------------------------------------
-----------------------------

* Make the Client text editable again. Improve handling of selections.
* In VSCode, load a new file in the Client after a short delay, rather than
immediately. This provides a more efficient process when changing files.

Version 0.1.33 -- 2025-Sep-02
--------------------------------------------------------------------------------
-----------------------------

* Change `<graphviz-graph>` syntax, which now correctly translates from the
Client to source code, avoiding data loss in previous versions.
Expand All @@ -195,46 +199,46 @@ Version 0.1.33 -- 2025-Sep-02
* Correct a data loss bug when deleting multiple sequential doc blocks.

Version 0.1.32 -- 2025-Sep-01
--------------------------------------------------------------------------------
-----------------------------

* Improve tooling for VSCode extension.
* Improve selection handling in the Client.

Version 0.1.31 -- 2025-Aug-31
--------------------------------------------------------------------------------
-----------------------------

* Correct EOL handling on Windows which caused data corruption.

Version 0.1.30 -- 2025-Aug-30
--------------------------------------------------------------------------------
-----------------------------

* Correct ordering of messages sent to and from the Framework to the Client.
* Fix and improve test framework and error reporting.
* Improve MathJax bundling.
* Update PDF viewer.

Version 0.1.29 -- 2025-Aug-23
--------------------------------------------------------------------------------
-----------------------------

* Fix bugs in PDF viewer.
* Fix error when scrolling before a document is loaded.
* Fix debug print statements.

Version 0.1.28 -- 2025-Aug-13
--------------------------------------------------------------------------------
-----------------------------

* Fix navigation in document-only mode.
* Improve errors reporting in the VSCode extension.

Version 0.1.27 -- 2025-Aug-05
--------------------------------------------------------------------------------
-----------------------------

* Correctly handle document-only files.
* Update to the MathJax 4.0.0 release.
* Improve release process -- include release notes taken from the changelog.

Earlier releases
--------------------------------------------------------------------------------
----------------

* v0.1.26, 2025-Jul-31:
* Additional data corruption fixes when applying edits.
Expand Down
32 changes: 16 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
Welcome to the CodeChat Editor
================================================================================
==============================

The CodeChat Editor is a GUI-based programmer's word processor /
[Jupyter](https://jupyter.org/) for software developers. This document describes
its basic features and use. In contrast, the [style guide](docs/style_guide.cpp)
provides strategies for effectively employing the CodeChat Editor to improve the
software development process.

<iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=QNrYCiTLVCpxpAbD&amp;list=PLOJAqFa3UI2FJncc-OBRPhh17NJXQP6ve" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
<iframe title="YouTube video player" src="https://www.youtube.com/embed/videoseries?si=QNrYCiTLVCpxpAbD&amp;list=PLOJAqFa3UI2FJncc-OBRPhh17NJXQP6ve" width="560" height="315" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen="allowfullscreen" referrerpolicy="strict-origin-when-cross-origin"></iframe>

Full manual
--------------------------------------------------------------------------------
-----------

Read the
[manual rendered using the CodeChat Editor](https://codechat-editor.onrender.com/fw/fsb/opt/render/project/src/README.md),
since this documentation doesn't correctly render on GitHub.

Installation
--------------------------------------------------------------------------------
------------

Install the
[CodeChat Editor extension for Visual Studio code](extensions/VSCode/README.md).
For developers, see [building from source](docs/design.md).

Structure
--------------------------------------------------------------------------------
---------

The CodeChat Editor divides source code into code blocks and documentation (doc)
blocks. These blocks are separated by newlines; the image below shows the
Expand All @@ -47,21 +47,21 @@ screenshot shows:
See the [style guide](docs/style_guide.cpp) for more examples.

Editing
--------------------------------------------------------------------------------
-------

Edits may be made either in the IDE hosting the CodeChat Editor, or within the
CodeChat Editor window itself. Edits made in one place are transferred to the
other after a short delay.

Navigation
--------------------------------------------------------------------------------
----------

Switching documents in the IDE likewise switches the document shown in the
CodeChat Editor. Likewise, following hyperlinks in the CodeChat Editor to a
local file loads that file in the IDE, as well as showing it in the Editor.

References to other files
--------------------------------------------------------------------------------
-------------------------

The CodeChat Editor supports hyperlinks to any recognized file type; to refer to
another source file, simply insert a hyperlink to it. For example,
Expand All @@ -84,7 +84,7 @@ docs/
```

Images
--------------------------------------------------------------------------------
------

Likewise, the path to local images is relative to the current file's location
(see the preceding diagram for the location of `monitor.png`). For example
Expand All @@ -99,7 +99,7 @@ the image data is embedded directly in the source file. Avoid this; instead,
place images in a separate file, then reference them as shown above.

Projects
--------------------------------------------------------------------------------
--------

The CodeChat Editor can either display a single file, or a project. In a
project, the table of contents is displayed on the left, while a file within the
Expand All @@ -110,7 +110,7 @@ the table of contents. See the
for a simple example.

Mathematics
--------------------------------------------------------------------------------
-----------

The CodeChat Editor uses [MathJax](https://www.mathjax.org/) to support typeset
mathematics. Place the delimiters `$` immediately before and after in-line
Expand All @@ -126,7 +126,7 @@ See [Latex Mathematics](https://en.wikibooks.org/wiki/LaTeX/Mathematics#Symbols)
for the syntax used to write mathematics expressions.

Diagrams
--------------------------------------------------------------------------------
--------

### Mermaid

Expand Down Expand Up @@ -223,7 +223,7 @@ can be directly edited by that package:
![](docs/sample_diagram.drawio.svg)

<a id="supported-languages"></a>Supported languages
--------------------------------------------------------------------------------
---------------------------------------------------

* C/C++
* C#
Expand All @@ -247,14 +247,14 @@ can be directly edited by that package:
* YAML

Issues and feature requests
--------------------------------------------------------------------------------
---------------------------

Please report issues and provide suggestions for improvement using the
[Github page for this project](https://github.com/bjones1/CodeChat_Editor).
Contributions to the code are welcome and encouraged!

License
--------------------------------------------------------------------------------
-------

Copyright (C) 2025 Bryan A. Jones.

Expand All @@ -275,7 +275,7 @@ License along with the CodeChat Editor. If not, see
[https://www.gnu.org/licenses/](https://www.gnu.org/licenses/).

<a id="notes"></a>Notes
--------------------------------------------------------------------------------
-----------------------

1. The image used comes from
[Monitor icons created by prettycons - Flaticon](https://www.flaticon.com/free-icons/monitor "monitor icons").
Expand Down
Loading