Implement help section (hook_help)

Comments

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented
Status: Active » Needs work

Added a README.txt file into CVS.
Its just a very basic start.

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented
Version: 6.x-1.0-alpha1 » 6.x-1.2

see #744916: Links don't work

betamos’s picture

betamos commented

README file needs information about how to configure the module.

Some kind of community documentation would also be handy. I'll do it as soon as I get my CVS account.

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

You dont need a CVS account to patch =)

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented
Assigned: Unassigned » betamos
CinemaSaville’s picture

CinemaSaville commented

How do I use this with CKEditor?

betamos’s picture

betamos commented

There is a README.txt in linkit/editors/ckeditor

We will be improving the documentation soon, but if you have any questions just ask.

EDIT: The README I referred to is only if you use CKEditor without WYSIWYG.

CinemaSaville’s picture

CinemaSaville commented

Ah OK. You hid it in there. You may want to put that in the main Readme.txt Thanks again for doing this. I'll let you know how it goes.

betamos’s picture

betamos commented

Yep, sorry about that. We will be working with major improvements on the documentation overall in the next weeks.

If you want to help us, tell us what you think about Linkit. We need all feedback we can get right now, since the project is pretty new :)

CinemaSaville’s picture

CinemaSaville commented

I love linkit. However, had not had the chance to use it much, but when I used it on Chrome, it crashed the browser the first time I did. I'll try to do more later. Thanks again. This is a great addition to the workflow.

betamos’s picture

betamos commented

Commited a better README for 6.x branch now. We'll look out for that Chrome bug, btw. Thanks!

jgdemat’s picture

jgdemat commented

It would be useful to also include the linkit/ckeditor/README.txt into the help.

betamos’s picture

betamos commented

Sure, I'll make sure there is only one README and that all info from the other README's get there. It'll be an awesome new stable release coming up soon with lots of improvements.

Daythorn’s picture

Daythorn commented

Is there any instructions for how to install Linkit on CKEditor with WYSIWYG?

I am a beginner and don't really understand how to make this work.

And is Linkit working with HTML Purifier too?

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

@daythorn

Should be the examt same as using WYSIWYG and TinyMCE.

-- INSTALLATION & CONFIGURATION --

1. Install and enable Linkit's dependencies (see below). Make sure
Path Filter is enabled on the input formats you intend to use with linkit
2. Install and enable linkit (required) and at least one of linkit_node,
linkit_views and linkit_taxonomy
3. Enable the Linkit button in your WYSIWYG editor's settings

bryancasler’s picture

bryancasler commented

How do I enable it with just CKeditor installed, not WYSIWYG?

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

@animelion:

FROM linkit/editors/ckeditor/REAMME.txt

##############################################
## ONLY if you use ckeditor WITHOUT wysiwyg ##
##############################################

Installation:

Do the following steps to add Linkit button to the CKEditor toolbar:

1. Open /drupal/modules/ckeditor/ckeditor.config.js

2. Add button to the toolbar. The button name is: Linkit
For example if you have a toolbar with an array of buttons defined as follows:

['Link','Unlink','Anchor']

simply add the button somewhere in the array:

['Linkit','Link','Unlink','Anchor']

(remember about single quotes).

3. Scroll down to the end of the file, right before "};" insert:

// Linkit plugin.
config.extraPlugins += (config.extraPlugins ? ',Linkit' : 'Linkit' );
CKEDITOR.plugins.addExternal('Linkit', Drupal.settings.basePath + 'sites/all/modules/linkit/editors/ckeditor/');

bryancasler’s picture

bryancasler commented

Thank you anon, got everything working, except now I believe HTMLPurrifier is stripping the generated links out. Can you take a look at my post on that issue que and let me know what you think. http://drupal.org/node/838496

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

Added a comment on http://drupal.org/node/838496#comment-3138040 about HTML Purifier

bryancasler’s picture

bryancasler commented

Thanks anon, that took care of it.

bclinton’s picture

bclinton commented

I had an issue where I could see the Linkit button in ckeditor, but it would not open as if it was disabled. Firebug showed an error:

      Drupal.settings.linkit is undefined
      http://demo.domainname.com/sites/all/modules/linkit/editors/ckeditor/plugin.js?t=A1QD
Line 22

To resolve this I needed to set some settings in Drupal Site Configuration -> LinkIt

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

@bclinton: Good point, I will look at this.

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

@bclinton:
I unistalled Linkit, and installed it again, but I cant re-create that error msg. Its works perfect for me.

cverond’s picture

cverond commented

I had the same Drupal.settings.linkit problem. It was the Theme Developer module that made Drupal.settings disappear.

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented
Status: Needs work » Closed (fixed)
aimevp’s picture

aimevp
Primary language Dutch
Location Belgium
commented
Version: 6.x-1.2 » 7.x-1.1
Status: Closed (fixed) » Active

I'm having the same problem with the D7 version.

I don't have Theme developer enabled and I'm trying to use Linkit on a CKEditor only installation.
I'm pretty shure (not absolute) I've done everything mentioned in the readme files.

The only problem I encountered was the second point in the extra readme file for Linkit without wysiwyg where one had to add the button in the toolbar in the ckeditor.config.js file. In my config file there was no toolbar specification as everything is configured in the CKEditor settings in the configuration page of the module. I added 'Linkit' there and when I go to my edit-page I see the linkit icon but nothing happens when clicking it.

After a while I thought it could have something to do with the directory where I installed Linkit as I put all the contributed modules in a directory "contrib" within my "modules" directory. (sites/all/modules/contrib/linkit)
But when I uninstalled the module, move it to the root of the modules directory and enabled it again nothing had changed. So, I'm not shure it has something to do with it.

Anyone ideas what else I could try, or is it a bug?

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented

Hi hatznie, sounds like you have some JS errors.

The Linkit popup is triggerd by the editors own functions, so I cant see why this should be a Linkit problem.
Are you running firefox for chrome browser? If you are, do you have time to see if you can get some extra info from the JS-console?
When you push the Linkit button, there should be some JS errores.

anon’s picture

anon
Primary language Swedish
Location Gothenburg
commented
Status: Active » Closed (fixed)

Also, Please create a new issue for this.
This issue isnt about that, its about documentation.

Thanks.