start > User Guide - Basics

User Guide - Basics

Created by tkarakai. Last edited by tkarakai, one year and 212 days ago. Viewed 11,278 times. #15

[diff] [history] [edit] [rdf]

labels

Parent:	FAQ
Category:	snipsnap-documentation

attachments

This page is a result of my ongoing exploration of SnipSnap as an end-user. Many of these information I couln't find in the official documentation (as of 06/30/2004) so I tried to summarize them here.

Weblogs and Wiki pages

I call Weblogs and Wiki pages in general documents in SnipSnap.

Both use the wiki syntax.
Both can reference (link) either wiki pages or weblogs.
Both can be commented.
Both have Snip Names: a string by which other documents can refer to them.
Wiki pages have their own Snip Names defined by their author, weblogs do not: they will have a name consisting of the date created plus a sequence number differentiating from other weblogs on the same day.

Wiki pages

Text documents authored using a web browser containing hyperlinks and formatting acheived by an easy to remember special syntax.

Wiki page actions:

Action	Description	How to
Create	Create new page at root level.	Edit the start page, create a link with a new Snip Name of the page to be created, save start, click on the new link which will take you to edit the new page, add content and then save it.
Create child	Create page as a child page of an existing page. (That is the new page will be located under the parent page, not "categorized")	Method 1: View the parent page and click new. It will take you the "create new snip" page where you can create the page and specify it's parent. Method 2: Edit any(!) existing wiki page or weblog, add a link containing: 1. the path and the name of the parent page, 2. a slash ("/"), 3. then the name of the page to be created. If the parent is a child page itself then the whole path to that page needs to be included. Examples: [MyBook/Intro], [MyBook/Chapter/Sub/Exercises] Then save the page/weblog and click on the link just created. This way the new child page will already be referenced from at least one place (in Method 1 the new page will first be ony be found in the snipsnap-index or by searching...)
Edit	Change the content of the page	View the page and click edit (if you don't have privileges to do so, the edit link will be disabled or missing).
Attach File	Associate file(s) to the page, accessible only from this page (i.e. images can be referenced from within the associated page)	View the page and click add file (if you don't have privileges to do so, the edit link will be disabled or missing).
Lock	Prevent others to edit it, add attachments to it, label it or create child pages with the new link .	View the page and click lock. If you don't have privileges to lock, you will not see the link. Note: locking does NOT prevent creating child pages of the locked page by Method 2, as descrived above!!!
Rename	Change the title of the page, as well as change all other pages/weblogs linking to this page to refer to the newly defined title	SnipSnap does NOT support this at this point. You can copy the page to have a new name and even it's location (path), then delete the old page and then update all references to the old page to point to the new one...
Copy	Make another page with different name and the same content	View the original page and click copy. You will ned to specify the full path and the name of the new copy (that is including the parent(s)).
Move	Change the location, that is the parent "space" of the page.	SnipSnap does NOT support this at this point. See workaround producing similar results for the Rename action.
Delete	Purge the page and all it's previous versions, that is: as if the page has never existed.	View the page and click delete. If you don't have privileges to delete the page, you will not see the link. Only users with admin privileges can delete any document, that is if you are not an admin, you cannot even delete your own documents! - Deleting a document will NOT remove/update links in other documents pointing to the document deleted, they will appear as invalid links (will go to new page creation when clicked on). - Deleting a document will delete all comments on the document. - Deleting a document which has a child document is possible, the child will NOT be deleted, just the parent reference will be disabled/invalid.

Weblogs

Timestamped text with one's thoughts displayed in chronological order usually on the main page of a web site groupped by date.

Weblogs are also attached to a parent document. The default parent document is start.
All attributes of the Comments descibed above are true for weblogs, except the syntax of the links they can be referred to is a little diferent: The name is based on the date of creation but still have the sequence number in them:
```
[<parent-page-path-and-name>/<YYYY-MM-DD>/<weblog-sequence-number>]
```
Examples:
```
[start/2004-06-29/3], [MyBook/Chapter/2004-06-29/3]
```
where both are referring to the third weblog on June 29th, 2004, under their indicated parents.
Weblogs can be displayed by including the {weblog} macro on their parent page.

Commenting/Discussions

Comments appear as timestamped text written by a user on the related wiki page or a weblog. There can be many comments on a document, shown in chronological order on the bottom of the parent document.

Comments can use the wiki syntax.
Comments can be edited by only their authors.
Each comments is a document of it's own. A specific comment can be referenced by a link with the following syntax:
```
[comment-<parent-page-path-and-name>-<comment-sequence-number>]
```
where <parent-page-path-and-name> is the page being commented, and <comment-sequence-number> is the number differentiating the comments for the same parent page. Example:
```
[comment-MyBook/Chapter1/Excercises-3]
```
which refers to the third comment on the indicated page.
Comments are also versioned, can be copied, labeled and have attachments, but only if you link them from another document the way described above and view them by clicking on the link. Then the usual action links will appear on the page...
Comments can be deleted only by admins. Admins can delete their own comments strait with the delete link displayed next to the comment, others' comments can be deleted by linking to the specific comment and clicking on the delete link while viewing the comment.
Commenting on a comment (possible if viewing the specific comment document) will end up as a new comment on the parent of the first comment.

one comment (by rajeshrdp) | post comment

see also:
snipsnap-documentation	snipsnap-search	HOW-TO	Installation & Configu...
User management	Misc FAQ	Snipsnap-documentation	SnipSnap for Software ...
User Management	snipsnap-help	User+Guide+-+Basics	snipsnap-changed
install	jeancf	SnipSnap Users Mailing...	FAQ
Tomcat	WYSIWYG		Testimonials

Sun	Mon	Tue	Wed	Thu	Fri	Sat
		1	2	3	4	5
6	7	8	9	10	11	12
13	14	15	16	17	18	19
20	21	22	23	24	25	26
27	28	29	30	31