Visualise Workflow Diagram from plain text - version-control

Assuming there is a plain text with description of the workflow (Just plain English in some predefined format).
Are there any tools (better online) to visualize the flow based on a plain text?
What for: to store the description of the workflow in a source control system and be able to quickly remember/understand that.

Honestly I find the idea appealing but doubt it could be practical. You mention "plain text" but not sure if this means source code or a natural language description.
If it is source code maybe you can find something that automatically generates flowcharts from a specific language (you could have better luck if you stated what the language is).
If you are trying to extract a flowchart from a high-level English (or whatever) language descriptions I think it will prove quite a challenge.
If I had to do this, I'd go with Perl starting by https://metacpan.org/pod/Text::Flowchart::Script for the "rendering" while reading a bit on NLP for the parsing (ex.: http://www.perlmonks.org/?node=41281).

Related

no "tags" / "structure tags" in libHaru PDF?

I am using libHaru (by including the source in my C++ code) to generate PDF files. I am hoping to make these PDF files accessible by adding "tags" (aka "structure tags"). From what I can see in the documentation and source code, libHaru does not support this. Can someone confirm that libHaru indeed does not support tags? And if it's not supported directly, I wonder if there is a way to add tags by modifying the libHaru code? Has anybody done this?
I looked through the 22 page manual for libHaru, and there was no mention of tags, so I think it's safe to assume that it doesn't support tagging.
Attempting to make any library tag PDFs (and do it well) would be a non-trivial task. You'd essentially be re-inventing the wheel. Consider the fact that Adobe Acrobat Pro is only just mediocre at tagging PDFs and requires a ton of human intervention to get it right.
There is a product called CommonLook Dynamic that is made for creating accessible PDFs from live data on a webserver, but I can't vouch for it myself. I have used other products from this company, and they've been very good, but they're not at all cheap.
Generally speaking, PDF tagging is often a very complex thing. To make it work with an automated algorithm, the source code formatting has to be perfectly formed and dead simple. If your source material is at all complex or malformed, it won't come out right.
As an example, it's not possible for PDF generation software to do a good job at things like crafting good alt text for images, creating useful PDF metadata, or tagging complex tables. These are things that require human intervention.

Tools for manual translation of Constants/Messages .properties files

I'm looking for some tools that could be used by human translators during the process of translating our GWT application into other languages.
Currently, we have the English version of .properties files containing constants and messages, and need create the files for other languages. This tool should be easy to use, so even non-IT-lover can master it.
Or, do you suggest other method for translation of the texts?
I heard the "community" approach becomes quite popular, by that I mean that one uploads his texts to some (?) forum, and the community there creates the translations into other language - but as I said, I don't know much about this
Are there any online platforms for this purpose?
any other ideas?
See my SO answer for VB 6 source code, speech text is in french want to translate to english. The same answer works if you replace the computer langauge "VB6" by "JavaScript".

How can I generate comparable spec documents?

Currently in my company we're using Excel as a tool to write specs.
On the kind of projects we're working on, spec changes are a matter of course, and constitute a lot of the work, beyond the implementation.
I'm looking for a tool that will allow me to write a spec, including screenshots and arrows, but with comparable content. i.e., something that will allow me to compare between versions of the spec.
Free tools are better, but I guess anything with a license of less than 100USD will be OK too.
MS Word handles text and pictures, and has a document diff'ing tool built in. Open Office (being a MS Word Clone) may have something similar, and is free.
Maybe XMLmind Editor will interest you.
There's an excellent free Sequence Diagram editor: QUICK SEQUENCE DIAGRAM EDITOR. It's artifact is an xml document with CDATA tag which encloses simple DSL used for SD declaration.

Industry experience with WYSIWYG editors

Just wanted to get an idea for ways (web) developers get round the short fall of (most) WYSIWYG editors, whereby the users that are editing the text aren't always HTML literate enough to produce good/great results.
In the past we have resigned ourselves to either locking down the editor or simply not supplying one.
What are other peoples experiences?
If I understand your question correctly, my advice would be to allow basic text formatting in the editor (bold, italicize, underline, paragraph breaks, etc). Anything beyond that should be handled either by custom fields in your CMS system that talk to the corresponding template, or directly by your designers / front-end people. There really should be no designing going on in your text editor.
Also, using a templating language like Markdown might help editors feel more comfortable formatting their pages.
If you have the resources (as the question implies you do) you get the users to supply copy and designs in what they do know (Powerpoint, Word, Fireworks, etc) and get the people who can do a correct implementation (but who might not be able to write decent prose, etc) to put it into the HTML/CMS/magicthing.
Sometimes it is possible to use something like WYMeditor - it isn't that simple but produces clean semantic code. The other way is using some wiki-like code - Markdown for example. And you can ease editor's life by using some helpers like MarkItUp editor (it also supports original Wiki and Textile).

MS Word is evil! Is there a good alternative? [closed]

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
As a developer I really don't like writing documentation but when I have to I'd like to make the process as painless as possible.
The problem with Word is that it constantly gets in my way. I worry more about the layout than about the actual content ... that's why I'd like to get rid of Word.
Ideally I'd like to write my content and then 'compile' it into a document.
I've heard of LaTeX but I don't have any experience with it whatsoever. Would this be the right technology for the job? What editor (Windows) should I use? Is it a good idea to start with LyX?
EDIT: I'm not asking about documenting code (I use Sandcastle for that).
Update 2014:
We have now switched to GFM (GitHub Flavored Markdown).
It's really easy to work with.
Write code & documentation in the same IDE!
Everything can be versioned!
Get great output either as raw txt, html or pdf!
My solution to this was to invest some time in creating a decent Word Template for myself.
The important thing to do is make sure you have a Style defined for everything you can put in the document.
Once you have all the Styles defined and all of the document content tagged with the correct Style instead of formatted in an ad hoc fashion, you'll be surprised how easy it is to produce good looking Word documents quickly every time.
The wider problem here is that everyone spends hours in Word and yet it is very rare for companies to invest in Word training. At some point you have to bite the bullet and take the time to teach yourself how to use it properly, just like you would with any other tool.
Anything you can do with LyX you can do with LaTeX. LaTeX is suitable for all sorts of things; it has been used for everything from manuals to lecture slides to novels.
I think LaTeX is probably worth looking into as an option; if you've ever wanted to "code" for your word processor, LaTeX is for you. At the simplest level you can define new commands to do things for you, but there's a lot of power there. And the output looks really neat.
In my opinion, LyX is fantastic in certain circumstances, handy in others, and occasionally just gets in your way. I think it should be seen as a productivity booster for LaTeX. In other words, learn to use LaTeX before trying LyX. Both are of course free and available for Windows, though the learning curve is quite steep compared with MS Word. For long documents, or plenty of similar documents, LaTeX/LyX is probably a worthwhile investment.
I've found that wikis can be good for this. Find a wiki you like that lets you do a bit of formatting, but nothing really heavy. Ideally it should let you format code easily too - to be honest, the markdown available on SO is probably a good start.
That way:
You have change tracking built-in (assuming a decent wiki)
You can edit from anywhere
Everyone always sees the same documentation (instant distribution)
You can concentrate on content instead of formatting
You could write your documentation using your own XML format and then transform it into any format with XSL (e.g. PDF via FOP+XSL-FO ).
See also the DocBook XML format.
LaTeX is an extremely powerful tool and might well be overkill here as it is designed for scientific/mathematical literature. It has a (relatively) steep learning curve and can be tricky to coax to do exactly as you want if you're new to it. I LOVE LaTeX, but it is not really a general purpose word processor.
Have you considered OpenOffice instead?
LaTeX is really a very powerful language if you need to write documents.
Perhaps you can try texmaker, a cross-platform LaTeX editor:
Texmaker is a clean, highly
configurable LaTeX editor with good
hot key support and extensive Latex
documentation. Texmaker integrates
many tools needed to develop
documents with LaTeX, in just one
application. It has some nice
features such as syntax highlighting,
insertion of 370 mathematical symbols
with only one click, and "structure
view" of the document for easier
navigation.
What about using HTML? This way you could then publish the documentation if there will be need for many people to access it from many places.
Despite all efforts and reasonable expectation I don't think Word Processing has been "solved" yet.
My response to what I also personally find a deeply frustrating experience with MS Word is to avoid it altogether and use an auto-documenting tool like GhostDoc to generate XML from what I've already written in the code (DRY!) and deal with the XML from an XSLT based intranet site or similar later.
Are you talking about documenting your actual code? If so, I recommend Doxygen for unmanaged code and Sandcastle for managed code. Both will compile your help or build it as a website for you.
Both applications will read special tags above functions / classes / variables and compile that into the help.
Well I've never found anything wrong with MS-Word in the first place. (i.e if you take the time to know how to use it effectively). OpenOffice indeed is an amazing & credible free alternative - but then if you hate MS Word for layout related problems, the same problem is gonna occur with OpenOffice too.
Never tried the Latex system myself, but have heard its good for scientific work. I think using some HTML WYSIWYG editor would be best for you, if you want to just focus on the content.
I considered a wiki, but I decided to go with a modified Markdown notation, for the simple reason, that a wiki's content isn't easily exported and distributed outside of the wiki itself, while the Markdown can be rendered into HTML.
Answer to chris' question about my workflow: I write the documentation with a Notepad-like application (TextWrangler, only because of its word-wrapping feature) in its raw Markdown format. Then I have a small localhost documentation website with my modified Markdown parser (extended for a few features and a bit more HTML-oriented functionality) that checks for the timestamps for the documentation files - if a file has been updated, it parses that file into HTML, and stores the file in a cache.
This way I'm able to edit the source documentation on my desktop, and just press F5 in my browser to see the results immediately.
I haven't got around to trying it yet, but I've always thought AsciiDoc would be good for this kind of thing.
If you want something simpler than LaTeX, you can have a look at ReStructured Text
Read this book: http://en.wikipedia.org/wiki/The_Pragmatic_Programmer . There is some idee fixe inside, so that documentation should be built automatically. Think about using your IDE for this, or look for some additional tools. Most modern languages support generating documentation as you write the code. This can simply maintain your doc in touch with latest changes in the code.
I prefer to use a RTF editor which is a lot less clunkier than words. This way the formatting and all the headers/footers nonsense will not take up half your time. Wordpad has worked for me on several occasions. I'm stuck with Word for now though :(
there are a lot of possible ways:
embedded documentation, e.g. javadoc: good for describing APIs, not so good for the "big picture"
plain html: can be checked in under version control, a definite plus
a wiki, e.g. confluence -- great for collaboration, but has version control different from your source
LaTeX or somesuch: better suited for books or papers than typical documentation; support for graphics is cumbersome
an Office clone, e.g. OpenOffice: mostly the same as Word+Visio, but open source, with a nicer document format
I usually document the software structure (the "metaphors" of a project, component interrelations, external systems) up front, using Visio, in "freeform" UML. These are then embedded in confluence, which can be converted to PDF if someone wants a printout.
LyX
LyX is a WYSIWYM front end to LaTeX: You get the convenience of a document processor (somewhat similar to Word) with the consistency and power of LaTeX: It doesn't get in your way and can do a lot of things that professional writers need.
Note: The correct answer for you really depends on your way of thinking --- we can't decide this for you. This answer simply shows an excellent choice if you think of documentations as documents and want something similar to Word (where Word is good) that doesn't suck as Word (where Word is bad for programmers).
But many programmers think of documentation differently and hence prefer different metaphors. I myself had the same problem years ago, worked with LaTeX (as I am a mathematician), found LyX and finally settled on a Wiki/Source system that I wrote myself.
Vim is the solution for anything that means writing plain text in the most efficient possible way. If you need formatting, then use XML, Latex or something similar (in Vim).
Vim changed my life!
Simple answer: LaTeX sounds like just what you are looking for.
I use it for writing documentation myself. I will never go back to Word if I have the option.
At phc, we started with latex, then moved to docbook, and have settled (permanently I hope) on Restructured Text/Sphinx.
Latex was chosen because we are academics, and latex is the tool of choice. I believe it didn't generate good enough HTML.
Docbook was chosen for power, but it was very unwieldy. It put us off writing any documentation: code had to be manually formatted, we kept forgetting the syntax, and it was difficult to read. The learning curve was also steep.
Finally, we moved to reST, using sphinx, and that was a great decision. Documentation is now very easy to write, and both PDF and HTML versions look beautiful (though the PDF could do with some customization). Its very easy to customize too.
The best bit about reST though, is that its human readable in source form. That is a wonderful advantage. I've switched to using reST for all my stuff now, especially anything over the web (except of course academic papers, where one would be foolish to use anything but latex).
You may want to look into doxygen at http://www.doxygen.nl/, see their nice examples. In this case, the documentation is presented by tags in comments in the source.
Another option would be to use an online system like trac from http://trac.edgewall.org/ which is a wiki/doc/issuetracking system that lives on top of subversion.