Writing Stack Exchange is a question and answer site for the craft of professional writing, including fiction, non-fiction, technical, scholarly, and commercial writing. It only takes a minute to sign up.
Sign up to join this community
Many word processors are capable to tracking and displaying changes made to a document. Those changes are typically displayed in special markup supported by the editor. E.g.
But when using a plain text editor (like Microsoft's Notepad), is there a useful markup technique that editors can use to suggest changes, without losing any of the original text?
I kind of doubt that there is a standard for it, at least. You might get away with using some marker that isn't used anywhere else, like ###, to indicate a changed passage, but I'm not sure if that really qualifies as markup. In any case, it would have to be an agreement between the people involved which marker(s) to use and what they mean. Something like this:
Tracked changes look like ###this[WAS: these]###.
That said, depending on the technical inclination of the author(s) and editor(s), you might get away with something like setting up a GitHub account and uploading the text file there. Source control systems tend to be somewhat more geared toward programmers, but they solve your problem quite nicely: they allow multiple persons to work on a single text file (even simultaneously), tracking changes over time, displaying the differences between arbitrary versions, going back and forward between versions, and selectively rolling back any changes made.
It may take a little getting used to for someone who isn't technically inclined, but if you are serious about doing this with only plain text files, it's a reasonably easy way forward once you get over the initial learning curve. And for writing, there's likely no need to deal with the more complex issues such as branching/merging and such; a linear history will likely work well enough.
It's been a few years since the above question was posed. Now, there is at least one system, CriticMarkup, designed to give plain text writers functionality that is similar to Microsoft Word's "track changes" feature.
This is a good question. Unfortunately, outside of the programming realm, there's no system for tracking changes at the character level that I'm aware of. (If there is one, I'd love to know about it!) I suspect there are many, many such systems that have been cobbled together by individuals, however.
This comes up often when blogging: Do we use Word files with their awesome change tracking features and then deal with all the garbage they produce before posting (possibly introducing errors)? Or do we work in plain text from the start, cobbling together some sort of change system like the one Michael suggests?
If you absolutely need something like this, I recommend using marks that are catch the eye. [[[triple brackets]]] or ***lots of asterisks*** or ###other such signs###. (If you're working on source code or HTML, this could cause problems later. And, as you can see, sometimes lots of asterisks render as bold-italic text, indicating yet another problem.)
Rather than embedding changes in the text itself, is it possible you could simply use versioning and the name of the person? For example, SampleFile_EditorNF_v1.0.1.txt may have meaning if you and your colleagues have agreed on a system. You could then use the compare revisions of a robust editor (such as BBEdit) to compare versions and see the changes.
Another option is to use commenting to describe the changes.
Personally, I would use a simple version control system like mercurial: there's no need for a server, you just pack up the entire directory (which contains the repository with all the version history), and trade it back and forth in email, for instance.
You could also use a simple text-comparison tool, like diff: save your original file and have your editor make all of their changes and save that to a different file. Then you can just run diff to compare the two versions and see what changed. The nice thing about this is that your editor could run diff and save the comparison to a patch file, and then add comments directly to the patch file to explain each change that was made.
If you want to mark-up a text then the obvious solution is to use a mark-up language. The best known example today is HTML but the power of XML is that you can create your own tags (and share them with your collaborators through a DTD).
You can
<suggest>track</suggest> follow changes such as removing redundant<replaced> unnecessary extra</replaced> words.
Note that Markdown interprets invented tags as mark-up even when it does not know what to do with them. To get the paragraph above to appear correctly, I have used the tick character as an escape on the eginning and end of tags.
The earliest/simplest I had known and the one that survives to-date with enough support is the classic was: -- (it's already been mentioned in the passing by @Michael Kjörling in his answer).
I do not know much beyond the near-horizon (spatially and temporally) what people did or are doing, but I still use it in config files and the sort.
PDL_NAME=devNAME
UninstallLevel=1
PST_DEL=OFF
AUTHORITYCHECK=ON
CheckJobMonitor=ON [was: OFF]
DelRestoreFile=OFF
Suggested changes similarly are indicated by a "query":
PDL_NAME=devNAME [? portNAME]
UninstallLevel=1
PST_DEL=OFF
AUTHORITYCHECK=ON
CheckJobMonitor=ON
DelRestoreFile=OFF
I'm not sure. You could save the file as an html document and use the <!-- Hello --> tags to denote suggested changes. When I worked at a freebie weekly, we used the comment function in Windows Word to suggest changes. The changes were then added in using red text and strike through's.
I've never used Notepad, but can it create PDFs? Or at least print to PDF?
Because Acrobat Pro has a dandy set of markup tools which I use all the time for proofreading emails:
Instead of trying to find a markup standard you should stick to the methods utilised by the tool. They wouldn't deviate too much from general markup standards and most of the time they hide the markup from the editor and just display it when needed. There are gazillions of text editing tools out there. I'm using at least 3 or 4 different tools with probably different markup and/or versioning methods. I don't care for the details and just benefit from the output.
In addition to the tools suggested by the commentators (criticmarkup, acrobat pro, xml etc) I can get down the tools I'm currently using or did use in the past which all are capable of marking, commenting, drafting and/or versioning content.
Draftin is an online tool for just writing plain text in a collaborative setup and has a few extra markup features above the basic feature set.
Currently I'm creating service and end user documentation in Confluence which has many powerful collaboration, markup, versioning etc features.
In the past I've used Redmine which again had many built-in (or extendable with addons) powerful markup and versioning features.
I'm also using Microsoft's and Google's online word processing and spreadsheeting tools which have almost every feature for collaboration, versioning, commenting, or marking up content.
