I'm using Semantic Media Wiki in conjunction with the Lingo Extension and the Semantic Glossary Extension to build a glossary. Often definitions of a term include links to other terms. For example: Computer - A calculating machine which uses a -CPU- to execute calculations. The definition includes a link to the term 'CPU'.
Now I wonder: Is it possible to nest a link to a wiki page inside a property / value definition?
I tried the following without success:
A [[Glossary-term::Computer]] is a
[[Glossary-Definition::calculating machine
which uses a [[CPU]] to execute calculations.]]
Does anybody know how to reach this structure?
Thanks for your ideas an suggestions!
I found the solution through the SMW mailing list citing SMW Configuration Page :
You can use
A [[Glossary-term::Computer]] is a
[[Glossary-Definition::calculating machine
which uses a [[CPU]] to execute calculations.]]
but you have to add the following to your LocalSettings.php in the MediaWiki root:
$smwgLinksInValues=true;
Related
I have a lot of documents of same type and i want to organize them in folders and subfolders. Is that possible in sanity?
Sanity doesn't have a concept of generic folders/subfolders in the traditional sense. But there's a new(ish) feature called Structure that makes it possible to declare nested navigation hierarchies in the content studio. Sounds like it could be a good match for your use case: https://www.sanity.io/docs/content-studio/structure-builder.
In particular the section about segmented content would be relevant I think: https://www.sanity.io/docs/structure-builder/how-it-works#segmented-content
Structure was introduced in version 0.134.0, so you may have to upgrade your content studio with sanity upgrade to start using it.
im searching for a Documentation Framework that supports the following features:
Generated from Code Comments
Searchable
Styling customizable
NTH: Linked references (If i reference a class somewhere class name should be linked to class documentation)
I want to use it to document an RESTfull API i'm working on
I know about YARDoc, but would be nice to gather some alternatives
Matt Silverman created a pretty comprehensive lists of what is available out there now for gen'ing docs from code.
http://www.mattsilverman.com/2013/02/tools-to-generate-beautiful-api-documentation.html
Apart from YARD, you can generate RDOC project documentation using the following rake task:
rake doc:app
After this, your docs will be located in the doc/app folder and can be viewed by opening the index.html file in your browser. It will include the (currently probably generic) doc/README_FOR_APP file.
Hope this helps :)
I would like to provide custom definitions for financial terms (in different languages) in my application using the UIReferenceLibraryViewController, which was introduced in iOS 5.
However, I have not found any information on how to add custom definitions to the reference.
Do you have any suggestions on how to implement this useful feature?
From the documentation:
It should not be used to display wordlists, create a standalone dictionary app, or republish the content in any form.
So, you won't be able to add new definitions.
A quick search on github gives some dictionary sample apps that could be a starting point. See : http://github.com/mattneary/Etymology-for-iPhone or http://github.com/ioseb/LinGEO
I'm new to MODx, but am quite impressed with its power and flexibility. There's only one caveat, and I'm hoping it's just because I don't know any better.
I'm a frontend dev, and I'm used to building websites of all sizes. But I usually work with files and version control. How would I keep this paradigm with MODx?
From my poking around so far, the only way I found to use an IDE, is to keep static files with my code, to later on copy/paste into MODx Manager. Far from ideal.
I'm aware that a lot of people use an "include" snippet, to include snippets, chunks, etc. Does this work for MODx specific tags? For example, if I include a file as a snippet, and I have a template variable defined in there (or a resource link), would that be properly rendered?
Also, is there a performance hit using a snippet by including a file, vs having the snippet code entered into MODx Manager?
Bottom line, how do you develop sites on MODx? Where do you enter your code? Is there a feature like the "Import HTML" but for snippets and chunks? Is there a way to create new Templates, Documents, Chunks, TVs, etc. without going through the Manager?
Thanks in advance!
there is a whole documentation site for developing in modx, http://rtfm.modx.com/display/revolution20/Home - though it mostly concerns extending it - not customization & modification. The short answer is no, there is no version control for your snippets & such, yes, you will have to maintain them manually. [I wish that was not the case]
Most of your php code will go into either a snippet or a plugin, and yes you can include static files in either of those resource types, no, I on't know if there is a performance gain/loss, but I would imagine "no" if your include is cache-able.
for the includes you can do something like this:
include_once $modx->config['base_path'].'_path_to_my.php_';
-sean
There is VersionX for revolution that will allow you version control of chunks, snippets, resources and so on.
There is package called Auditor that will allow you to implement version control in Modx
EDIT
Sorry just noticed your question is tagged Revolution, Auditor is for Evo. I don't think there's a solution available yet although I believe it is on the Roadmap
I'd love to ask you how do the guys developing dojo create the documentation?
From nightly builds you can get the uncompressed js files with all the comments, and I'm sure there is some kind documenting script that will generate some html or xml out of it.
I guess they use jsdoc as this can be found in their utils folder, but I have no idea on how to use it. jsDoc toolkit uses different /**commenting**/ notations than the original dojo files.
Thanks for all your help
It's all done with a custom PHP parser and Drupal. If you look in util/docscripts/README and util/jsdoc/INSTALL you can get all the gory details about how to generate the docs.
It's different than jsdoc-toolkit or JSDoc (as youv'e discovered).
FWIW, I'm using jsdoc-toolkit as it's much easier to generate static HTML and there's lots of documentation about the tags on the google code page.
Also, just to be clear, I don't develop dojo itself. I just use it a lot at work.
There are two parts to the "dojo jsdoc" process. There is a parser, written in PHP, which generates xml and/or json of the entirety of listed namespaces (defined in util/docscripts/modules, so you can add your own namespaces. There are basic usage instructions atop the file "generate.php") and a Drupal part called "jsdoc" which installs as a drupal module/plugin/whatever.
The Drupal aspect of it is just Dojo's basic view of this data. A well-crafted XSLT or something to iterate over the json and produce html would work just the same, though neither of these are provided by default (would love a contribution!). I shy away from the Drupal bit myself, though it has been running on api.dojotoolkit.org for some time now.
The doc parser is exposed so that you may use its inspection capabilities to write your own custom output as well. I use it to generate the Komodo .cix code completion in a [rather sloppy] PHP file util/docscripts/makeCix.php, which dumps information as found into an XML doc crafted to match the spec there. This could be modified to generate any kind of output you chose with a little finagling.
The doc syntax is all defined on the style guideline page:
http://dojotoolkit.org/reference-guide/developer/styleguide.html