Site Notes: Hidden Design or How To notes in Your Database

Ever design a siteA logically grouped set of content - also web site. and happen on a nifty trick that you may want to use again? You wrote it down and lost the paper, didn't you.

You designed a great siteA logically grouped set of content - also web site. for someone else, and the first thing they do is call you up and say "How do I do...?"

You can't remember all the modules, themes, and CSSCascading Style Sheet - a hierarchical means of specifying how to format HTML elements on the page changes you made and it's time to upgrade...

You'd love to put all that stuff on the web siteA logically grouped set of content - also web site., some place easy to find, but safe from casual hackers...

Well, here you go... Introducing SiteNotes. A simple moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. lots of uses.

SiteNotes introduces a new content type, called, coincidentally, "sitenotes." But wait... there's more... It also creates a menu item in the Admin, SiteA logically grouped set of content - also web site. building menu, where it's available only to privileged users. It's even protected by Access Control.

So now all those little Post-Its™ and other scraps of paper can go right into your databaseA collection of data related to an application. where you can find them again.

Create "How To" notes for your users, themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. changes, CSSCascading Style Sheet - a hierarchical means of specifying how to format HTML elements on the page modifications, special code notes, and keep them safe AND available.

This offer is not available in stores. Do you want it?

See the change log


The SiteNotes moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. is simple in structure.

  • It creates a new content type, called a "SiteA logically grouped set of content - also web site. Note." It has standard configuration options.
  • It puts a menu item in the Admin >> SiteA logically grouped set of content - also web site. Building menu so you can list out the notes.
  • It shows a teaser list of all the notes with a "read more" linkThe technique which points to another page, anywhere on the Internet, from the current page. if they are bigger than the teaser length.
  • It creates an entry in the Access Control list so you can limit permissions to see/use it.

Why would I want to use it?

  • "How To" notes for your client.
  • Track CSSCascading Style Sheet - a hierarchical means of specifying how to format HTML elements on the page changes.
  • Track custom code, such as themeFor web sites, this refers to the "look and feel" of the site. It is also used to describe the code to produce that look. modules.
  • Reminders of how to do something you don't do often enough to remember exactly.
  • Billing notes.
  • To Do lists for admins.
  • Succession notes for the next webmaster.
  • Use your imagination!

The Sitenotes moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. does have an uninstall feature. It will delete all nodes created with the moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. as well as the "sitenotes" content type.

SitNotes and MarkSmarty not working together?

Starting a new SiteA logically grouped set of content - also web site., I also started my documentation with SiteNotes. Thanks for this moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP..

Now I installed "Markdown and SmartyPants" to simplify input. It works as expected, but the SiteNotes overview pages (teasers only) don't get filtered by the input filter.

Is this intention or a bug or a misconfiguration on my side?
Using Drupal

Drupal

An open-source content management system that is used on this site and is taking over the world. 6.1

Open an issue

Please open this as an issue at http://drupal.org/project/issues/sitenotes.

I'll have to look at how the teasers are produced.

Annotations

You might have a look at http://drupal.org/project/annotate, which claims to be what you're speaking of. ;)

greetings,
sun

Thanks.

This moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. is already in contrib status. I changed the linkThe technique which points to another page, anywhere on the Internet, from the current page. above to point to the project page.

The moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. you mention is interesting but not quite what this one was created for.

Site Notes block already exists?

I hope you got my last thank you note for the moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP.. I just noticed that there's already a 'Site NotesA Drupal contributed module by Nancy Wichmann for hidden design or how-to notes.' block in my 'Blocks' list - I guess that must be the one that's created by this moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP., something which I didn't notice before? Hmm, too late Columbus! :) Oh well, it was an exercise for me to create a custom Views-based block...

This is great - something like what I was looking for...

I am still playing around with my siteA logically grouped set of content - also web site. on my test machine - localhost. There have been times when I try lots of things to get something to work, and I move on - but when I have to reinstall the whole set up, I need to remember what I did the last time I got something to work. This is great. I have my own documentation - a form of diary software that I use. But, this moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP. being 'inside' the Drupal

Drupal

An open-source content management system that is used on this site and is taking over the world. set up is more convenient and more logical. In fact, I went ahead and created a 'Views' block that lists my most recent site notesA Drupal contributed module by Nancy Wichmann for hidden design or how-to notes. - so I can go back to them and add further...uh...notes... :)
Since I just recently learned to use 'Views' and 'Taxonomy', the first 'SiteA logically grouped set of content - also web site. Note' I created was actually on how I got the 'Site NotesA Drupal contributed module by Nancy Wichmann for hidden design or how-to notes.' block to display on my page! Thanks for the moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP.!
This is not exactly a feature request - but I just thought, if there's a way to 'export' all the site notesA Drupal contributed module by Nancy Wichmann for hidden design or how-to notes. as text files - in just one go - perhaps at the end of a project, then we would have some sort of collection of 'How To's' outside of our Drupal

Drupal

An open-source content management system that is used on this site and is taking over the world.
siteA logically grouped set of content - also web site....May be there is a way already (?) which I don't know about...

Hmm...

There are some contributed export modules; I don't know if any have been upgraded to D5 (or D6).

Please submit a feature request and I'll think about how it might be done, preferably interfacing an existing moduleAn add-on, or extension, to Drupal to provide additional functionality; written in PHP..