Recently in our organisation we've decided to work with maven site plugin and maintain all the documentation about our project in the site generated by maven.
However I haven't found any way to add a search functionality, the only thing I've come across that some skins provide an integration with the google search engine, but I can't use it because we're running in our own network and there is no chance to make it 'indexable' from outside.
So, my question is whether someone can suggest a descent solution for this?
I thought about developing a kind of maven plugin that would run lucene and index everything by itself and then provide an API to use this search from within the site, but I hope I won't need to reinvent the wheel :) So any suggestion will be welcome here
Thanks in advance
Just an idea, you can try to use JavaScript based full-text search engine e.g. http://jssindex.sourceforge.net/
We are using constellio to index the published site on a schedule. That works well so far.
I've raised http://jira.codehaus.org/browse/MSKINS-88 to cover adding a generic search form to the fluido skin which we use to build our maven sites. Hopefully that'll be progressed and we can have the search form baked into the documentation.
I know this is an old question, but a very easy (and admittedly ugly) way to accomplish what you want is simply generating a PDF with the site contents and letting your users do the search on the PDF. The advantage over searching on the generated site is that any PDF reader will be able to search the whole document.
mvn pdf:pdf
If you cannot use Google Site Search you're dependent on local search implementations. Hence, you either need to build the index during the site build (and for it to be available as part of your site) or do both index and search in the browser.
Besides JSSindex which appears to be somewhat dated there's http://www.tipue.com/search/ which is based on jQuery.
Maven site plugin approach is not widely used. So there is nothing specific for indexing yet.
You should look at non-maven tools.
Related
Problem
I want to be able to save an image of either a div or a page (whichever easiest) without using dependencies.
So I have been browsing around for awhile to find many solutions to this problem, most of them I have found use dependencies such as BrowserShot or something else. I was wondering if there was some way to do this without dependencies other than ImageIntervention to manage the images.
I decided to use google's speed API for taking screenshots. I originally was trying to avoid this due to not being able to use it for development since that would be hosted locally.
The solution is described pretty well here.
I'm looking for an example to go off on how to setup a search bar for a project I'm working on.
I've got a mongodb database and am using nodejs with the express framework.
I'd like to have autocomplete and suggest functionality for the search bar.
I've had a look at typeahead.js but am overwhelmed by how to implement it. If anyone knows of a place to find a working version (that I can upload to my dev environment and take apart) or has the time to run be through it step by step, I'd be very grateful.
Alternatively if there is a much easier to achieve what I want to do, let me know.
Thanks in advance.
My recent research has shown a blog post that might be of help.
http://physalix.com/jquery-autocomplete-search-with-node-js-and-mongoose/
edit:
Sorry for the brevity, unfortunately I am of novice level with node.js so I don't want to submit code directly on here as I cannot confirm it has been tested and will work.
The link above does look like it will work and has been vetted on the original article post as functional. As a general example I believe this will definitely lead you in the right direction to a functioning search bar with the functionality you require.
Note this doesn't implement typeahead.js but works in a similar fashion.
I wrote a Javascript (jQuery) plugin. Now I want to write a documentation site for it. Is there a good tool to create such a site out of some offline file formats or works like a CMS?
I know this answer has been asked before, but the last answers are from 2011. Is there anything new that does an awesome job in writing documentation?
There are a few new tools for generating websites or blogs from code/directory.
Bootstrap v3 just switched to jekyll for documentation. jekyll knows how to process Markdown or Liquid (markdown flavours)
Grunt.js is also used for all sorts of automated task. One of these being documentation generation. Search their plugin list for doc
assemble.io is another tool for generating documentation pages
I'll extend if I bump into others. I am not sure if this is exactly what you need, but they are general purpose so I am sure a jQuery plugin can fit in.
I'm playing with Joomla 2.5.9 (The latest 2.X download). Do you know how you can add additional menu's to the "Article Manager: Edit Article" page? (This is in the Administration)
Their API gives me some hint on several things but I am don't know what this right "Slide Down Option Area" is called in the Administration.
In the right area there are things such as:
Publishing options
Article Options
Configure Edit Screen
Images and Links
etc..
I want to know where to start to add my own, or where they are already built in the system so I can base mine off it -- Is this a plugin, module, or something else? :)
As i say don't change any of the core file in Joomla. If you want to add any functionality into the article manager you can make your own plugin to add functionality in it. For doing this see this link :
Creating a content plugin
I hope this is what you looking for.Good luck.
There are some extensions that allow you to do that.
I recommend (although somewhat buggy and a code mess) this one:
FieldsAttach
It does exactly what you want.
Or, you could make your own as Toretto suggests, there are some tutorials on creating a plugin for extra items in the article form, but the already-made-extension route seems to make more sence.
I've been using FieldsAttach for this sort of thing, for a few years, the code is often a little messy, that is true, but the the concepts are clean and eloquent. Brian Teeman explains it well from an integrator point of view in his talk at https://www.youtube.com/watch?v=f2WLKWbRj5U but in some ways it is even more compelling from a developer's perspective.
However, after watching Marco Ding's Joomla Day UK 2016 talk on https://www.youtube.com/watch?v=KDh1IPuZAVA I think DPFields may be a better choice. The architecture is perhaps more rugged and neater, but also because it may well end up being a core extension in Joomla in the near future. More info on DPFields is at http://extensions.joomla.org/extension/dpfields , https://joomla.digital-peak.com/products/dpfields and https://joomla.digital-peak.com/documentation/162-dpfields .
I'm new to Ruby/Redmine/Redcloth but I'm trying to achieve the following:
The default way to build a link in Textile is "foo":http://bar. However, 90% of the day I use Atlassian products, which use [foo|http://bar] as link markup.
To keep everything a bit uniform I'd like to implement this in Redmine via a plugin. However, it appears that you can't change the macro syntax so instead I'll have to look into extending RedCloth to accept this form of inserting links.
Does anyone know how I can achieve this?
Thank you and merry christmas,
Dennis
You might consider switching to one of the two Markdown plugins (one is Markdown Extra-like, based on Bluefeather), which are a bit more similar in link style, although not the same as what you are used to. Since you use SO, though, you're obviously familiar with it.
Otherwise you'd have to write a full plugin, for which either of the plugins I've mentioned would serve as a good model. Best of luck.