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
CSDL includes elements Documentation/Summary and Documentation/LongDescription that, according to MSDN, can be used to document entities. The contents of these elements conveniently appear in the properties window of the entity design surface, so it is easy to jot a few notes in these fields as you're working with entities.
Since the EDMX file is XML, it would be easy to write an XSLT stylesheet to pull documentation from these elements. Is there a standard tool for doing this? Are there any other advantages to using the CSDL documentation fields? Is anyone using these fields, and if so, have you found them to be an effective way to document your entities?
The documentation data stored in the CSDL is emitted as XML doc comments in the generated code. As a result, it will appear in the intellisense tooltips in Visual Studio automagically:
If you want to use it for more formal documentation you can use SandCastle (optionally together with the excellent frontend SHFB), or some other Xml DocComment extraction tool to build windows help files or help websites containing the documentation.
If your database is documented using the documentation attributes in SQL Server, you can extract that documentation from the database and populate the SSDL and CSDL comments using this tool: http://huagati.com/edmxtools/
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 2 years ago.
Improve this question
Is there any OOTB solution to filter some properties like cq:lastReplicated, cq:lastReplicatedBy , etc, I wanted to migrate some code from lower environments to higher these properties shows the newly moved content in author also as replicated especially on sites content. So planning to create the packages with the filters without these properties.
There is no such possibility at the moment. I would suggest to use groovy script (https://github.com/OlsonDigital/cq-groovy-console) to remove not needed properties.
As others have mentioned that there is no such functionality yet. You can either use groovy console or other alternatives as mentioned above or you can unzip your package and use text manipulation to clean the content.xml files to remove the properties. I am sure that some simple XSL or command line should be sufficient to do this.
Package manager is a node level tool so nothing is available to filter properties yet.
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'm working on an opensource project on Github. I'd created some documents in Github's md format. However I want those documents available in three formats:
PDF: To be downloaded with project
HTML: To be hosted on my personal site.
Markdown (.md): For Github.
Obviously I'd not prefer to write them thrice. Is there any way I write it once anywhere (although MS Word preferred) and it could be converted to other two formats?
Consider Pandoc
I'd write in Markdown and convert to the others.
Another possibility is DITA. Its free reference implementation, the DITA Open Toolkit, lets you generate HTML and PDF out of the box, and can be customized to generate Markdown as well.
But, DITA might be a more sophisticated solution than you need, depending on your requirements for content reuse, the size of your docs, how frequently you update, whether you will be employing a technical writer to maintain and update your docs... It's a powerful solution better suited for a dedicated documentation effort than a one time ad-hoc situation.
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 have created one library, and now I want to have its documentation, so Is there any document generator available? If yes, What I have to keep in mind while generating documents.
http://www.doxygen.nl/
Doxygen is probably the most widely used option. Because it's not just for ObjC (doxygen supports many other languages), the development is lively and the community quite strong. HeaderDoc (now an open source project), by comparison appears to have largely stagnated. HeaderDoc only produces HTML output, while doxygen also produces PDF, LaTeX and many other output forms besides HTML. Even seems to recommend doxygen, with this guide to automatically producing documentation sets, compatible with 's help viewer, from within your build process.
It's worth noting that doxygen can read HeaderDoc-style comments, so you can write your documentation in HeaderDoc style and decide later whether to produce the final output using doxygen or HeaderDoc.
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 want to be able to create UML diagrams from source code - and I found UMMF - UML Meta-Model Framework. However, I could not find any tutorial to get me started on creating a diagram with two classes and a simple relationship between them.
Basically what I am trying to achieve for now, is to create a simple two tables diagram in a relation of 1..n:
The XMI output for this diagram, is pretty verbose, because I created the diagram with Enterprise Architect - you can find this XMI file here (I could not embed the text here because is too big)
I want to use UMMF because it creates XMI files, based on perl object hierarchies that are related to OMG UML standards and those files can be imported in any modelling tool that implement those standard.
So the question is, how can I create this diagram using UMMF? - it is not necessary to be that complex.
I need the diagram to have:
two tables
at least one table to have:
one field as primary key
one indexed field
one regular field (not indexed)
a relation between the two tables
Also if you know of the existence of any good Perl UMMF tutorials, please show us their links
UML::Class::Simple can create XMI files from source code. That may be a good starting point.
You can use UMMF to programmatically create UML models from Perl and export them to XMI. However, UMMF only supports UML 1.5 -- a standard graphical diagram meta-model didn't exist until UML 2.0 AFAIK.
You might want to look at Graphvis: http://www.graphviz.org/
I've done some basic stuff to create UML-like diagrams with it. It has some basic support for record-oriented diagrams.
Someone could probably write a XMI->Graphvis transformer using UMMF. :)
BTW: I'm the author of UMMF.
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 3 years ago.
Improve this question
We are building a website that contains a large number of database tables that need to be edited by the CMS administrator.
Some of the tables are fed by form submissions from users on the front end of the website.
Some of the tables are purely in the CMS and are used to create custom modules on the front end of the website.
Although there is a forms module in Drupal, I think our requirements cannot be met by it.
Does anyone know of a system that allows forms to be saved to a CRUD style database with the following features?
(source: yart.com.au)
Export of all database fields.
View a summary of the records in a filterable table.
With paging
You can have one to many relationships in records eg
(source: yart.com.au)
To code this manually for 10 forms is A LOT of work. Particularly the one to many relationships. If there is a powerful module available it would save us writing one.
I have not used it at all so far, so I have no clue if it fits your needs, but the Auto Admin module seems to offer at least some of the features you are looking for.
You should look at CCK and check that doesn't meet your requirements before building something bespoke. All of your requirements can be met with a combination of CCK, Views, and a bit of tweaking.
This CRUD operations can be achieved using Drupal 7 modules like data,schema,entity,views and ctools.
Nice article is here: http://subhojit777.in/crud-data-table-in-drupal/
In-place editing for Fields is also possible using quickedit module,but Backbone.js,Underscore.js libraries are required and your Theme should support.