HFS: Comment files: Difference between revisions

From rejetto wiki
Jump to navigation Jump to search
m (Reverted edits by 216.127.153.145 (Talk); changed back to last version by Rejetto)
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
Comments are normally entered by clicking on ''Comment''. This way they are stored in VFS files.
Comments are normally entered by clicking on ''Comment''. This ensures they are then stored in VFS files.


Sometimes this method is not enough: you can't right click on files inside real-folders. But you may also want to keep your comments in external files for other reasons. In these case you can create special files that will contain the comments. These files are not listed, but used by HFS to know comments.
But sometimes this method is not enough: you can't, for example, right-click on files inside real folders. You may also want to keep your comments in external files for other reasons. In these cases you can create special files to contain the comments. These files are not listed, but are used by HFS as comments (for related files/folders/elements).


There are 2 kinds of comment files:
There are two kinds of comment files:


== Single-comment files ==
== Single-comment files ==
For every file listed, HFS checks the existance of a single-comment file.
For every file listed, HFS checks for the existence of a single-comment file.
This is a per-file method. If want to use this method on 3 files, you need to create 3 single-comment files.
This is a per-file method. If you want to use this method on three files, you need to create three single-comment files.


Let say you have to comment the file '''test.zip''', you got to
Let's  say you have to comment the file '''test.zip''. To do this:
* create a new text file,
* Create a new text file.
* put the comment in it,
* Put the comment in it.
* save the file as '''test.zip.comment'''
* Save the file as '''test.zip.comment'''.


The single-comment file must reside in the same folder of the commented file.
The single-comment file must reside in the same folder as the commented file.


; Notice
; Notice
: single comment files can be disabled with the option '''''Menu → Virtual File System → Load single comment files'''''. It is enabled by default. If you disable it, then any ''.comment'' file will be listed.
: Single comment files can be disabled with the option ''Menu →Virtual File System →Load single comment files''. It is enabled by default. If you disable it, then any ''.comment'' file is listed. (ie. it is treated as a normal file).


== Multi-comment files ==
== Multi-comment files ==
This method work only on real-folders.
This method only works on real folders.


In the folder relative to your real-folder, you have to create a file ''hfs.comments.txt''.
In the folder relative to your real folder, create a file named ''hfs.comments.txt''.
Edit it, and for every comment you want to set, make a line like this <cite>test.zip=here goes my comment</cite>
Edit it, and for every comment you want to set, make a line like this <cite>test.zip=here goes my comment</cite>


3 comments, 3 lines, it's easy.
Three comments, three lines, it's easy.


; Notice : don't leave empty spaces before equal sign ('''=''').
Don't leave empty spaces before the equals sign ('''=''').
 
HFS can read comments from 4DOS style descript.ion files also.

Latest revision as of 16:24, 19 September 2007

Comments are normally entered by clicking on Comment. This ensures they are then stored in VFS files.

But sometimes this method is not enough: you can't, for example, right-click on files inside real folders. You may also want to keep your comments in external files for other reasons. In these cases you can create special files to contain the comments. These files are not listed, but are used by HFS as comments (for related files/folders/elements).

There are two kinds of comment files:

Single-comment files

For every file listed, HFS checks for the existence of a single-comment file. This is a per-file method. If you want to use this method on three files, you need to create three single-comment files.

Let's say you have to comment the file 'test.zip. To do this:

  • Create a new text file.
  • Put the comment in it.
  • Save the file as test.zip.comment.

The single-comment file must reside in the same folder as the commented file.

Notice
Single comment files can be disabled with the option Menu →Virtual File System →Load single comment files. It is enabled by default. If you disable it, then any .comment file is listed. (ie. it is treated as a normal file).

Multi-comment files

This method only works on real folders.

In the folder relative to your real folder, create a file named hfs.comments.txt. Edit it, and for every comment you want to set, make a line like this test.zip=here goes my comment

Three comments, three lines, it's easy.

Don't leave empty spaces before the equals sign (=).

HFS can read comments from 4DOS style descript.ion files also.