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 there some nice documentation for Windows batch scripting I can download and refer to while offline?
I can recommend:
An A-Z Index of the Windows XP command line.
It is more thorough than help and most importantly it provides several examples for each command. Example: FIND. There are also cross-references to other commands.
For offline reading you can capture the pages by using e.g. Wget (or some other tool that can follow links and down the content). I use Bart Puype's Wget binary for Windows.
(There is a similar one for PowerShell: "An A-Z Index of Windows PowerShell commands".)
You can always look at the command help by typing one of:
<command> /?
help <command>
And to see a complete list of default batch commands you just type:
help
Also, you can look up the commands in Windows Help. Just click on "Start" -> "Help and Support", then search for "cmd reference" and you will get the "Command-line reference A-Z" page in Full-text Search Matches. It's a complete list of all cmd commands (some of the are only available in batch scripts) and other command line applications.
Here's an 8-page PDF you can print out: Win32 Shell Scripting Tutorial.
Consider using PowerShell instead, if you can. More power, fewer headaches. It's the way of the future, scripting-wise.
You sound like you have a lot of learning ahead of you. If you do that learning in PowerShell instead of batch, you'll be in a better position at the end.
While it's useful to learn batch, sometimes using batch can be quite a hassle, especially when it comes to things like number crunching, text file parsing, HTML parsing, etc., etc. It's better to also equip yourself with knowledge of scripting using languages such as Perl and Python. Natively, you can also learn how to use VBScript/JScript. Here is the guide you can download and read offline.
Another
Command-line reference A-Z
It seems like all kinds of command line are in the left sidebar.
Google hits, for "windows batch scripting documentation" - first page:
http://labmice.techtarget.com/scripting/batchfiles.htm
http://www.allenware.com/icsw/icswidx.htm
Related
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 1 year ago.
Improve this question
The question is not the same as What’s the best way to generate a UML diagram from Python source code?, but the other way around.
Topcoder UML tool automatically generates code in only Java or C#. Since I need to create a very depended data structure at a point, I am hesitant to turn to Java. I want to use Python. So:
Is there an UML-like tool that
automatically generates Python code
from your diagram?
If there is, is it possible to generate it from the Topcoder UML tool?
Can you shortly compare the tools?
Enterprise Architect is able to generate python code code from UML diagrams.
It is also able to also perform some reverse engineering, and therefore maintain the two versions (UML and python) synchronized together.
However, I have never used it in that way, except for some small tests just to see it in action. I personally find productivity in Python so high, that even if I am really satisfied with EA, I prefer it just to document the design.
PyUML - a Python Roundtrip Tool for Eclipse
PyIdea: PyNSource UML & Patterns IDE for Python
You can use DIA, and then install dia2code, it will generate from UML to code in python. I use it in PHP5 and Java.
$ sudo apt-get install dia dia2code
The Umbrello UML modeller for KDE support Python as an export language.
Some tools:
Gaphor
pyUML for Eclipse
pyNSource
Search with Ubuntu found:
$ apt-cache search python uml
boa-constructor - RAD tool for Python and WxWindows application
dia2code - a dia-UML code generator
spe - Stani's Python Editor
Quick testing revealed that DIA is the only program, where you can export your UML diagram to Python. I am very suspicious about the quality of DIA because it is less intuitive to use than the Topcoder UML program. Perhaps, the other programs, suggested by other repliers, are better.
Try this link-
https://www.visual-paradigm.com/support/documents/vpuserguide/276/330/7400_instantgener.html
Select Tools > Code > Instant Generator from the toolbar. In the
Instant Generator window, select Python as the Language. Fill in the
Output Path, which is the directory where you want the code to
generate to. Select the classes to generate code. In the Diagrams
tab, you can select the diagrams to generate code for classes in the
selected diagrams. Alternatively, open the Model Elements tab and
select the classes to generate code.
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.
The community reviewed whether to reopen this question 3 months ago and left it closed:
Original close reason(s) were not resolved
Improve this question
I've developed a pretty extense API, and I have it on Postman, which works pretty nice. Now I have to generate an html doc to keep it versioned inside /docs along with my sources.
Is there a tool or a way to achieve this? I really don't want to write all this documentation. Sharing the postman collection is not an option.
I recently had the same problem and I did not find anything. So I created a simple tool to do it. It is a very basic javascript application written with react.js. At the moment it is very basic, but I'm working on it, so any feature request is welcome.
You can use it for free at: http://www.vernizzis.it/docman/
Plus you can get the code and modify it at: https://github.com/davidevernizzi/docman
Any comment is more than welcome.
UPDATE1: looking around I also found this project: https://github.com/JakeWorrell/docodile
and this feature request: https://github.com/a85/POSTMan-Chrome-Extension/issues/204
UPDATE2: the feature request (see UPDATE1) has been closed and the possibility of creating documentation has been added to Postman cloud. Here is the feature request closing comment:
This is available as part of Postman Cloud: http://blog.getpostman.com/2015/12/10/introducing-postman-cloud/. Cloud hosts, updates and maintains documentation for everyone. I'd suggest http://docman.launchrock.com/ and https://github.com/JakeWorrell/docodile for generating one-time documentation from Collections.
I know this is an old question and you probably found a solution by now, but still you might be interested by Postmanerator: https://github.com/aubm/postmanerator
Basically, this is how you use it from the command line:
postmanerator -collection=/path/to/your/collection.js -output=/path/to/doc.html
To get it installed, download the latest Github release. You need to pick the appropriate binary depending on your system. Then place it somewhere in your PATH.
See the documentation in the README if you want additionnal information. From there you will find recommandations for taking full advandage of the tool, or change the look of your documentation by using custom themes.
The Github presentation also provides a reference to a generated example documentation.
You will also discover how you can take advantage of a CI platform like Travis, to automate the generation and the publication of your documentation with Postmanerator.
As this is an open source project I'm currently working on, feel free to submit issues on Github if you have any ideas that can make it better.
You can install Newman using command "npm install -g Newman" and then run the command "newman run CollectionName.json -e envVar.json" from the location where you have saved your collection, where CollectionName.json is your collection name and enVar.json is the set of environment variables. This will generate html report in the same folder.
One prerequisite is to have node js installed.
You can also try the free tool that I made. It provides the documentation in .txt but you can convert it to pdf using your browser.
https://postmandoc.herokuapp.com/
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 8 years ago.
Improve this question
I like F# but sometimes I need something light and cross-platform and without .NET for sure.
I tried to use OCamL many times but seems like I just can't start it.
Installed IDEA, added OCamL plugin -> Doesn't work
Installed eclipse ODT plugin -> Can't launch even config OCamL compiler - too complicated
Even had tried NetBeans plugin a long time ago but even can't deal with it.
So, for now, I'm using ocamlc -o "main.exe" "main.ml" from the command shell and different light editors. I don't use Vim or Emacs, I'm using nano and I have a habit of usage full-featured IDEs.
I found various documentation (this is looking like the best to start http://caml.inria.fr/pub/docs/oreilly-book/html/index.html for me) but still being confusing when looking for something a bit specific alike sqlite access. found this: http://neugierig.org/software/ocaml/sqlite/ with strange api annotation and no examples. And all the documentation about IDE usage I found are outdated or doesn't work.
Addition subquestion: some people told me "don't use OCamL, it's a dead language for students with low libraries support and seems like dying, use python or ruby instead". But I like the beauty of OCamL. I want to give it a try. Tell me if that is normal to use OCamL for production code today?
thank you.
There is TypeRex, a new development environment for OCaml. Here is a summary of TypeRex features:
Improved syntax coloring
Auto-completion of identifiers (experimental)
Browsing of identifiers: show type and comment, go to definition, cycle between alternate definitions, and semantic grep;
Strictly semantic-preserving, local and whole-program refactoring:
renaming identifiers and compilation units
open elimination and reference simplification
Robust w.r.t. not-recompiled, possibly unsaved buffers
Scalable (used regularly on a few hundreds of source files)
There are some screenshots available on the website. The first release candidate is out since yesterday.
EDIT: The first release (v1.0) is out now :-)
There are a few options:
Tuareg for emacs was already mentioned: http://tuareg.forge.ocamlcore.org/
vim has a few options for OCaml integration, with one good example available here: http://www.ocaml.info/software.html#vim
OcaIDE seems to be the best option for Eclipse: http://www.algo-prog.info/ocaide/
Geany, Komodo Edit and a number of other editors have syntax highlighting support for OCaml and some extra IDE-like features which are independent of the programming language being used. Most of these have limited OCaml-specific support.
OCaml is not dead. Some of the more vocal industry users of OCaml are XenSource/Citrix and Jane St. Capital. The language does not receive the same public and community evangelism that some other languages receive.
It's been years, but I really liked emacs' tuareg mode http://tuareg.forge.ocamlcore.org/
But if you're afraid of emacs, then it's not the right tool.
I specially like the shell integration and the possibility to "throw" a function you're developping in the shell and then test it.
EDIT For the subquestion, OCaml seems dead, and it's a pitty. However you cannot compare it with ruby/python. I'd say it's main competitor is Haskell which seems to be growing in popularity.
Googling "ocaml ide" shows now http://camelia.sourceforge.net/ as the first result. Haven't tested it though, so I can't really say if it is recommendable or not.
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 have a project under continuous integration and would like to add end user documentation to the project. The end user documentation is a user manual, not API documentation. In our environment we use windows, c#, msbuild, cruisecontrol.net and subversion. We are currently using DocToHelp to create our help file, which is based on an msword document.
I'm looking for some guidance on how to manage the end user documentation. What documentation tools should I use? Should any of the documentation tools be part of the build script? Should the output files from the documentation tool be stored in subversion? What type of help files would be best to use?
We has been using XMLMind XML Editor to produce user documentation in the unified docbook format that can be stored in a version control system for the past 6 years. We use standard XSL transformations to generate user documentation from docbook in HTML and PDF format. Of course, this all is a part of the Continuous Integration and release build cycle.
Hope this helps.
I don't know DocToHelp but here is my take:
Even if it's the only thing you do: Start with adding your generated help file and all the files you used to create it in your version control system.
If generating the help file is not much more then processing a Word doc file then perhaps I wouldn't bother integrating it on the CI server. Your CI server's build artifact folder will just contain the help file as fetched from version control.
If there is a whole bunch of files (perhaps externally linked images in the doc?) and there is a chance of failure you could add it (if the help file building tool allows).
Basically what your CI server would prove then is if it can reproduce your help file from version control (did you commit and add everything?).
Taking it even further you could build automated tests which would examine the build help file and compare it with the referenced helpcontext IDs in the software itself. But here I am speculating (I haven't done helpfiles in ages :-)).
You might want to take a look at Doxygen:
http://www.doxygen.nl/
Doxygen is a documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#
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 4 years ago.
Improve this question
I'm developing in MAYA and looking for a good API to connect my models and to be able to control them programatically.
thanks.
hye oded, you can use MEL or python scripting for control objects and doing simple actions,
and you can use the c++ or Python via maya api to create complex tasks or heavy duty tasks, like creating deformers, expanding mel with new commands.
for resources in mel scripting i recommend "gnomon Mel fundemental" video tutor
and for the api i recommend "Complete Maya Programming" book
if you could do any scripting or api programming and you know some python,
you can easily program/script with python which is way easier than mel or c++
hope that will help you :D
There are a couple of apps for mel programming, but all they do is give you syntax coloring and maybe autocomplete. Nothing more advanced exists, which is just as well, because mel is just a terrible, terrible language: It really isnt good for anything other than quick hacks in Maya's script editor. You definitively should use Python.
You can use an external IDE, like Eclipse or WingIDE to control Maya, but it's tricky
http://www.wingware.com/doc/howtos/maya
Whether youll be doing Python scripting or API development, definitively have a look at PyMel, which is a vast improvment over Maya's native Pyhon implementation.
if you are on windows you can use PyScripter, to configure it you have to show autocomplete you have to follow these steps
Open Pyscripter for Python 2.6 if your python version in maya is 2.6.Click on Tools> Python Paths
Browse and add following path:('D:\Program Files (x86)\Autodesk\Maya2012\devkit\other\pymel\extras\completion\py')
if you are not able to add by step 2, you can manually add by
going to Tools > Edit Startup Scripts in python_init.py add the two lines
import sys
sys.path.append("D:\Program Files (x86)\Autodesk\Maya2012\devkit\other\pymel\extras\completion\py")
following above steps will give you ability to write in python and programmatically control you object inside maya.. externally from IDE... (this also give you the code autocomplete feature)