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
Short version
We need a Maven Doxia alternative being able to generate good looking PDFs (at least code snippets should be properly indented and have configurable font size). Maven guys proposed maven-pdf-plugin in DOXIA-419, but it has same problems. Aforementioned DOXIA-419 has details on difficulties we've experienced with Doxia.
Detailed version
We develop a BIG product providing Java/C/C++/C#/etc API. Tens of client-customized branches are maintained/developed simultaneously.
We need a tool to facilitate automatic document generation meeting these requirements:
Include arbitrary snippets from Java/XML/etc samples.
Confluence Snippet Plugin is a good example of this feature.
Generate good looking printable documents (e.g. PDF).
Generate online documents having clickable cross-references etc (e.g. HTML).
Unattended mode (e.g. should be easy to run document generation process from Ant script).
Documentation source content (from which PDFs/etc are later generated) should be kept in a human-readable easy-to-diff format.
Documentation source content should be kept in separate files (not Java sources).
Support (Java/xml/etc) syntax highlighting.
UPDATE:
8. Windows OS compatibility.
My open source project Dexy might work for you. It's an authoring tool rather than an automatic document-generation tool, so it's not like JavaDoc which creates a whole structure automatically. Source code and document content are kept separate, syntax highlighting support is very good, document snippets are available. I use LaTeX for good looking printable documents, but you could use any other text-based format that compiled to PDF if you preferred that. Re the clickable cross references, you'd have to write HTML templates which could then be populated automatically (I'm doing so now, replacing JavaDoc on a project). You can also run live code examples and include this output in your documentation.
http://dexy.it
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 3 years ago.
Improve this question
I would like to ask what and why would be the preferred tool for localizing Laravel projects? I have already used a gettext plugin and it worked well. I like using POedit which allows translators using it without programming skills. Plus, the translation hints are cool, too.
Is there any good reason for using Laravel native localization? Or, are there any cons of using gettext?
Thanks!
Why not both: GetText and native localization?
Using GetText with source text is great for developers to work quickly and efficiently on new features without having to "make up" keys, switching files, maintaining consistency between keys and source text etc. Also, using GetText makes it easier to check if everything is translated and you don't need to worry if some keys/values are obsolete.
Using PHP trans() with keys/values is great for copywriting. It's easy for the marketing team or CEO to change the text for all languages (included the source language) without changing the code.
For these reasons, we created https://translation.io/laravel that allows you to use both syntaxes at the same time (and we suggest to only use PHP key/value when the source text needs to be editable through the translation interface).
The package is here is you need more technical info: https://github.com/translation/laravel
The native localization method is described in the Laravel documentation. You basically maintain language files for all languages you want to translate to. To pull them out of the file, you use trans(), trans_choice() (for plural) or __() helpers in Blade template.
Thats the most basic translation handling. At one level higher you might want save all translations to the database. There exists a few packages on Github which doing this. Like:
https://github.com/dimsav/laravel-translatable
https://github.com/barryvdh/laravel-translation-manager
and more. Just search for Laravel Translation.
This method only works as long as you use Blade for the frontend. If you use VueJs, Angular or React, the blade helpers won't work anymore and you have to find different ways how to handle this. This might depend on existent language handling of the aforementioned frontend framework.
I wrote an blog article about that topic.
#Peter Matisko, can you give us a little update on how did you decide, which one are you preferring to use?
Personally I tried quite a couple of different translation libraries, but gettext is still first choice for me:
extract all the translations from code and generate translation files (*.po)
translations editor that runs on Mac, Windows and Unix (Poedit initial release ~20 years ago)
translating plural forms
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
Questions asking us to recommend or find a tool, library or favorite off-site resource are off-topic for Stack Overflow as they tend to attract opinionated answers and spam. Instead, describe the problem and what has been done so far to solve it.
Closed 9 years ago.
Improve this question
I am looking for a report generation tool in ruby or rails which allows the user to define a template, then fetch data into the created template.
I have been looking through "The Ruby Box: reporting section."
There are two reporting tools I have looked at:
Thin Reports: It is really good. You can create your own report template with the template editor. Then you can produce PDF reports using thinreports gems.
ODF Report: You can create a template ODF file using Open Office and MS Word, and you can use that template to generate the report.
Both of these solutions lack the ability to draw charts. Does anyone know of similar reporting tools that can draw charts within a given report?
I have tried the RTF Ruby Library. It works, but shares the limitation that it cannot draw charts and graphs.
The minimum requirements are:
Able to create customizable templates. (e.g. design layout, set font size, color, embed images etc.)
Able to draw tables and charts.
Template could be in Docx or excel or xml or any other common file format.
Report output report must be in Docx or RTF format.
Thanks
The axlsx gem is relatively new but seems like a good library. I haven't seen it used for anything more than simple tables yet, but it supposedly supports a lot of other Office Open XML components and features.
From the README:
With Axlsx you can create excel worksheets with charts, images (with links), automated and fixed column widths, customized styles, functions, tables, conditional formatting, print options, comments, merged cells, auto filters, file and stream serialization as well as full schema validation.
If you are using ActiveRecord, there is also acts_as_axlsx from the same author.
Here is an example I found that uses googlecharts api to produce charts for Thinreports:
Embed Graph using GoogleChartAPI
I have not used it though myself.
You can use the Pentaho reporting tool for your purpose. Pentaho Reporting is a suite of open-source reporting tools which allows you to create relational and analytical reports from a wide range of data-sources. The Pentaho Reporting Engine is able to create PDF, Excel, HTML, Text, Rich-Text-File and XML and CSV outputs of your data.
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
I would like to generate code documentation (C#, .net4) to MS Word file (.doc, .docx). This is not because I think it is better, but because it is easier to version control when compared to a set of HTML docs.
I am looking into the possibility and practicality of this and weighing the options.
I see doxygen can produce RTF documents. There is nothing wrong with doxygen, I just want to know if there is anything else out there (paid or not) to make sure I have weighed a few different options.
Edit: Just in case it isn't clear, I would like to create documentation of the summery comments in my C# code. Visual Studio exports this to XML already. Tools like doxygen inspects the code files them self. I want to convert these comments to Word docs.
You can try our VSdocman. It can generate various formats, including RTF, of the summary XML comments.
The code documentation is XML, right? This fellow says that you can open an XML document in Word by choosing "open with transform" from the Open dialog box. Apparently that prompts to you provide information that is then used to generate an XSLT. It seems like you could use this as the basis for your own XSLT if you want to persist it?
This detailed article about XML comments in Visual Studio also suggests using XSLT to display the XML on a web page. So, you could just as well import that XML into your Word document
SoftArtisan's OfficeWriter can programmatically create .doc and .docx files via a .NET API. It's pretty rad, check it out.
DISCLAIMER: I'm one of the engineers who built the latest version.
I would like to generate code documentation (C#, .net4) to MS Word file (.doc, .docx). This is not because I think it is better, but because it is easier to version control when compared to a set of HTML docs.
You should generate the documentation in whatever format you think is most helpful for users of your software.
Your code is presumably in version control. You can generate the XML with the API help directly from the code, and you can generate the help file itself (with whatever tool, in whatever format) from this XML. These output files don't necessarily need to be in version control at all.
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
Is anyone aware of command line tools that can validate CSS and/or HTML?
The W3C offers its validators for local installation, with directions to use from the command line, but the installation process is a nightmare for anyone who isn't a seasoned Java developer.
I've searched with Google, but can't find anything.
Ideally I'd like to use a tool (or tools) that I can point at my CSS, and have it report back on any errors. I want it to be local to increase the speed of my debugging cycles.
Ideally, the tools will understand HTML5 and CSS3.
There is tidy for HTML. It's more than a validator: it doesn't only check if your HTML is valid, but also tries to fix it. But you can just look at the errors and warnings and ignore the fix if you want.
I'm not sure how well it works with HTML5, but take a look at Wanted: Command line HTML5 beautifier, there are some parameter suggestions.
For CSS there is CSSTidy (I have never used it though.)
Regarding the W3C validator: if you happen to use debian/ubuntu, the package w3c-markup-validator is in the repositories and very easy to install via package management. Packages for other distos are also available.
And the W3C CSS validator is available as a jar, which is easy to use:
java -jar css-validator.jar http://www.w3.org/.
One of the most popular web-based validators is http://validator.nu.
On their About page, they list a command-line script (written in Python) for validation.
On Ubuntu, you can install the package w3c-markup-validator. It provides a CGI web interface. But you do not have to use it.
You can use my w3c-validator-runner to run the validator without having a webserver.
If that does not work, consider starting a webserver. You can then use srackham/w3c-validator.
WC3 has the source to their validators here: https://github.com/w3c
Although not directly a solution to your problem, you could consider using a CSS-extension framework for the validation part. I use SASS extensively in all my web projects and find it indispensible when you get used to it. Besides all the fancy mixins and variables features etc. it will also perform a validation of your CSS/SASS markup and report for errors as it is perfectly backwards compatible with regular CSS3. The nice thing is that it works as a Ruby Gem which means that it runs locally and can be integrated with other workflows through either Ruby or the command line (terminal in unix environment).
Take it for a spin: http://sass-lang.com/docs/yardoc/
Run sass style.scss and see what happens.
Not sure if this works but if you have Node & NPM there is: html-validator and html-validator-cli https://github.com/zrrrzzt/html-validator & https://github.com/zrrrzzt/html-validator-cli
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 9 months ago.
Improve this question
I am looking for a nice way to generate a nested site structure in ruby. I want something that I can propose to clients instead of msword documents. Something of the form:
Home/
index.txt
About.txt
Services/
index.txt
products.txt
blahblah.txt
with the .txt files being markdown, or whatever.
I actually want to import this into a cms system, and just want to hook into whichever static-site generator that I can use.
Otherwise I will do it myself, but it would be nice to use something else for integration with html preprocessors etc.
Take a look at Jekyll
there is also middleman for generating static sites
How about either of
Ace
nanoc
webby or
StaticMatic?
The simplest of those I have seen is Stacey, though it does not run static content, it generates it on the fly, and its in PHP, but yeah it's just files and folders, even if you drop images or videos or pdf's on the folder they will be managed and added automatically. And they are just .txt files. http://www.staceyapp.com/
But, if I had to choose a static compiler in Ruby I'd go with nanoc. It's the most powerful and flexible I've seen and once you configure it with the rules and such, it's just files and folders too.
There is also Stasis, I haven't tried it but it seems pretty good.
http://stasis.me/
Here's a gist featuring the most popular ones: https://gist.github.com/2254924
Monkeyman (Scala) supports markdown and SCAML, the Scala version of SCAML. It will basically copies and transforms a folder structure, in any way you like. Without any processing it will copy the structure as is, but it has a slew of decorators that not only are able to transform the content, but also the location to anything you like.
It doesn't support compass, SASS or any of that yet (although being based on Scalate, it probably does transform coffeescript embedded into the template pages, but I haven't tried that.)
DocPad works quite well. It supports a broad range of preprocessors.
Let's check my open source static file CMS it's taken markdown or HTML files from directory structure and generates HTML files.
It's written in Nodejs (source codes) and it's very flexible - you can choose to use React, Nunjucks or plain javascript for templates