Documentation clean-up [#1013456]

FullCalendar needs a cleanup before coding more.

Why?
- with current documenation and structure it's hard to contribute/help

Attached patch has a doc framework for D6. There are a lot of [TODO's].
We need to fill them in.

The views documentation is very poor. I didn't understand what all those functions did.
Maybe look at some other modules that implement those functions, I hope they have better comments...
(*hoping*)

We also need to have a proper folder structure:

/css (all the css files)
fullcalendar.custom.css
/includes (all the non standard include files)
/views (subfolder for the view include files)
fullcalendar_plugin_display_page.inc (<== bad name btw, but leave that untill we are migrated to git)
views_plugin_node_fullcalendar.inc
views_plugin_style_fullcalendar.inc extends views_plugin_style.inc
fullcalendar_views.inc
fullcalendar_drush.inc
/js (javascript stuf)
fullcalendar.views.js
/theme (template files)
views-view-fullcalendar.tpl.php
views-view-node-fullcalendar.tpl.php
CHANGELOG.TXT
README.TXT
fullcalendar.admin.inc
fullcalender.info
fullcalendar.install
fullcalendar.module

for example

Comment	File	Size	Author
#15	1013456-fullcalendar-15.patch	3.95 KB	aspilicious
#10	fullcalendar-1013456-10.patch	4.39 KB	tim.plunkett
#5	fullcalendar-1013456-5.patch	8.57 KB	tim.plunkett
#4	fullcalendar_D6_doc_start.patch	8.28 KB	aspilicious
	fullcalendar_D6_doc_start.patch	9.88 KB	aspilicious

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

aspilicious CreditAttribution: aspilicious commented 3 January 2011 at 15:24

great that just ate my spaces...
another try...

/css (all the css files)
--fullcalendar.custom.css
/includes (all the non standard include files)
--/views (subfolder for the view include files)
----fullcalendar_plugin_display_page.inc (<== bad name btw, but leave that untill we are migrated to git)
----views_plugin_node_fullcalendar.inc
----views_plugin_style_fullcalendar.inc extends views_plugin_style.inc
----fullcalendar_views.inc
--fullcalendar_drush.inc
/js (javascript stuf)
--fullcalendar.views.js
/theme (template files)
--views-view-fullcalendar.tpl.php
--views-view-node-fullcalendar.tpl.php
CHANGELOG.TXT
README.TXT
fullcalendar.admin.inc
fullcalender.info
fullcalendar.install
fullcalendar.module

Comment #2

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett commented 3 January 2011 at 15:29

Holding off on restructuring, see #1003602: Rename views plugins and reorganize files.

The docs do need love. But D6 still uses "Implementation of", not the D7 "Implements", and "Implementats" is definitely wrong.

Also, the fullcalendar_plugin_display_page is the only one that is named correctly, the convention is MODULENAME_plugin_PLUGINTYPE_NAME, where PLUGINTYPE is one of display, style, row, cache, access, argument.

Comment #3

aspilicious CreditAttribution: aspilicious commented 3 January 2011 at 15:43

Srry for the noise :).
Hahaha as I said this is only a framework.
Didn't new that D6 had different standards.

Comment #4

aspilicious CreditAttribution: aspilicious commented 3 January 2011 at 16:06

File	Size
fullcalendar_D6_doc_start.patch	8.28 KB

Another try for a framework

Comment #5

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett commented 5 January 2011 at 17:13

Title:	Clean up module before going further	» Documentation clean-up
Version:	6.x-2.x-dev	» 6.x-1.x-dev
Status:	Active	» Needs review

File	Size
fullcalendar-1013456-5.patch	8.57 KB

You may notice that I put this commit in the changelog for a 6.x-1.0 release today, don't make me change it :)

Comment #6

geerlingguy CreditAttribution: geerlingguy commented 5 January 2011 at 17:59

Status:

Needs review

» Reviewed & tested by the community

Besides a period on the hook_perm() docs, everything looks good to go. The define()'s at the top are annoying, but if that's how core does it...

Comment #7

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett commented 5 January 2011 at 18:17

Version:	6.x-1.x-dev	» 7.x-1.x-dev
Priority:	Major	» Normal
Status:	Reviewed & tested by the community	» Active

http://drupal.org/cvs?commit=475116
Needs to go on the D7 branch too...

Comment #8

geerlingguy CreditAttribution: geerlingguy commented 5 January 2011 at 19:01

Status:

Active

» Patch (to be ported)

Shouldn't it be?

Plus, we'll have to start working first on the 7.x branch, and backporting :)

Comment #9

tim.plunkett

he/him

English

Philadelphia

CreditAttribution: tim.plunkett commented 5 January 2011 at 19:06

As soon as I can get this, #980886: Require Libraries API, and #980810: Option to use fullcalendar.min.js in, I'm tagging 7.x-1.2 and moving onto 7.x-2.x. From then on, work will be done on 7.x and backported to 6.x.