Confusing naming for Nodewords / Node (key)words / Meta tags module
TallDavid - December 19, 2006 - 15:33
| Project: | Nodewords |
| Version: | HEAD |
| Component: | Miscellaneous |
| Category: | task |
| Priority: | minor |
| Assigned: | Unassigned |
| Status: | won't fix |
Jump to:
Description
The naming of the Nodewords / "Node (key)words" / "Meta tags" module is not consistent and is often confusing. For example, the drupal project page http://drupal.org/project/nodewords uses "nodewords" in the URL and "Node (key)words" as the title of the page. If the module is installed. the Home >> Administrator >> Site building page lists the module as "Meta tags". In discussion forums, this module is normally described as the "nodewords" module.
For consistency and ease of use, I recommend that the term "nodewords" be adopted in all instances.
#1
I prefer the name "Meta tags" as the module does more then just add "node (key)words" from which the name originates. In all links or documentation, the term "Meta tags" should be used in order to avoid confusion.
So, I've looked over the code and replaced "nodewords" into "meta tags" everywhere where the user is presented with it. When the code or documentation discusses the module name or code, "nodewords" is still used.
Setting this as "by design".
#2
You still cant use two separate names to identify the same module. If Meta tags is to be used as the identifier, then the project directory needs to be renamed to "metatags" and all documentation, code, project page should reflect this change. Consistency is important, and sooner or later any support pages will pick up the change and update as Drupal updates.
#3
I've looked over the code and replaced "nodewords" into "meta tags" everywhere where the user is presented with it. When the code or documentation discusses the module name or code, "nodewords" is still used.
However, the module page says: Meta tags is the preferred name.
I think this makes things most confusing (especially for first time drupallers) and therefore agree with BioALIEN: either "nodewords" or "meta tags" should be used for everything, and not some kind of mix.
#4
yes, i think so, too. For consistency the project should be renamed to "metatags", "meta-tags" or "meta_tags".
But then, alter all tables, variables and so on, too.
#5
[facetious]
While we're at it, can we please rename 'categories' into 'taxonomies' ... or 'taxonomy.module' into 'category.module'. I don't mind which, but it's really confusing having the menu item and documentation say one thing and the module code say another.
A simple search & replace should do it, right ?
[/facetious]
;-)
#6
#7
I will release a "metatags.module" for Drupal 6 and then the "nodewords.module" one.
#8
This is still the issue, and - at least to me - quite annoying sometimes...
Is it really so complicated to make the naming more consistent (and, intuitive)? I mean, if "Meta Tags" is somehow chosen (as it seems), why not simply rename module to metatags and this should be it...
#9
It is actually quite hard to rename CVS branches. Basically, if it was done (requires super-admin on CVS tree and some mojo) then it leaves everyone who has the old checkout without an upgrade path.
Annoying, and I agree is should be possible in a perfect world, but it's certainly non-trivial.
Possible a symlink may help, but even that is a very hairy work-around.
A clean break, maybe between D5 and D6 may be the answer. I dunno. Requires bigger CVS-fu than I can imagine.
#10
dww knows how :-)
#11
Or just ditch the existing project, start a new one with the correct name and shift all your focus on supporting D6 branch. Plaster a big notice on the old project page to direct users to the new module and location. Job done!
#12
That's more or less what I've had in mind... ;-)
Maybe to publish just another (last) version with the current name, to get the attraction of admins (put a big warning displayed somewhere at the admin screen). Who will not notice it, obviously doesn't care much about... The others will reinstall (replace) the module and this shall be it. Then, with a big notice, we can leave the present project to slowly cease...
BTW, I remember some project went through that about a year ago (maybe a bit more), but unfortunately don't remember exactly which one it was (maybe to get some advises about from the maintainer...).
#13
The project cannot change its CVS directory name.
Abandoning this project to create a new one only to be able to use metatags as CVS directory doesn't seem a good idea, to me.
#14
We only need dww with his CVS super-admin permissions to rename the folder.
#15
The name of the CVS directory containing the code doesn't make the code better. IMO, fixing bugs have the priority over renaming the directory containing the module code, which is a detail that who is using the module normally doesn't care of.
#16
Are you kidding again about a status code you do not understand? Why the hell have Robrecht given you access to his project...
Robrecht said he'd like to change if I remember correctly and WELL we have seen TONS of request and discussions to rename this confusing directory name! Don't close this case. It's not a bug it's a task that should be done somedays.
#17
In his first comment, Robrecht reported this:
In his last comment, he reported:
This has never been done, as the Drupal 6 version of the project doesn't have any metatags.module, which doesn't exist in version 6.x-2.x-dev either.
#18
This case is not the only one - it's only the last and this is mainly why it's postponed... (also to stop users opening new cases again and again). Search the queue and you will find numerous request to rename to meta tags. It seems to be a valid request if ~20-30 different users request this name change. I also fallen more than once about this... only look on the modules page and then try to find the sites/all/modules/metatags folder... (always keep in mind you are not aware about "nodewords" = "metatags"). Have fun updating the module if update_status page complains about a new version and you cannot find the folder.
#19
Kiam was given CSV access because he promised (and did!) to look into the code of nodewords to make it more extensible and performant. He really is cleaning up the project and implements a more sane module. We all should be grateful!
The name will change one day - with the help of dww or by creating a new directory for the code - but in the meantime it stays as it is.. confusing as it is. Live with it.
Leave this issue open as a "minor postponed task for HEAD". End of discussion.
#20
Guys, I first submitted this issue over 18 months ago. Untold hours of wasted time have been spent and confusion caused because of the inconsistency in this naming convention. The root of the problem still exists. Rather than arguing about it endlessly, let's bite-the-bullet, get the CVS super admins involved and get the problem fixed. Enough delay, let's get it done. Please.
#21
See the comment made from the maintainer; please leave the issue as it is, and respect the maintainer decision.
#22
Just FYI: I asked about this to chx, and he said it is not possible to change the name of the CVS directory used for a project. I get that if it is possible, it is done for a good reason, not because the maintainer was undecided about the name to give to a project.
#23
Kiam,
just to make it clear - first you say "it is not possible", later you say that "if it is possible, it is done for a good reason...". How can something impossible still be done, but just for a good (enough) reason?!
Or, shall this simply mean that someone thinks that the reasons we have are just not good enough (= it would be possible to do it, but he/she simply doesn't consider it worth to actually do it)?
#24
FYI the http://drupal.org/project/metatags namespace is available. If it were my module (and it's not, so it's up to the maintainers), I'd move code over to the new namespace after the next official release and use it for all future 6.x and 7.x releases. I think the proper name would benefit the end-users. But again, it's not my project so take it with a grain of salt.
#25
The answer I got from chx is that is not possible.
What I meant after is that supposing also that his answer was the short answer, I get that in that case he meant "we don't do it if it is not worth doing it"; this is just my supposition and my interpretation, as chx just said it is not possible, and asked me why I would do it.
#26
@Dave: That is probably what I will do, as I am thinking to make a version of the module that is not compatible with the current version, and it doesn't allow to import data from the database table currently used by Nodewords.
#27
I think that creating a new module that would contain more than the 90% of the code already present in Nodewords would confuse more the end user. I will create a new branch for the new code I need to develop (which will also include SimpleTest code, as Dave Reid suggested); using the same project will allow me to mark as fixed most of the issue reports opened for development snapshot 6.x-2.x-dev (and some of the 6.x-1.x-dev reports that still need to be implemented).
#28
Dave suggested to move the code and discontinue nodewords - not to duplicate. Aside - if we do not care about the CVS history, simply rename the CVS folder. We may also be able to create a "hidden" nodewords module in D7 and visible metatags 7.x-1.0 and automatically update to the new name...
#29
+1 for hurrying up and sorting this out please. It's been an issue for the last 3 years without resolution. My preferred solution is to move the existing code to the metatags module name under CVS and don't worry about CVS history for nodewords.
We wasted a significant amount of time after installing the 'nodewords' module and not being able to find reference to it in the module list. Then on the permissions page we were looking for 'Meta tags' and couldn't find that either. The module's folder name absolutely has to match the module's human-readable name or this confusion will occur.