HFS: Comment files: Difference between revisions

From rejetto wiki
Jump to navigation Jump to search
No edit summary
 
No edit summary
Line 1: Line 1:
Comments for files in virtual folders are normally entered via the VFS, but to comment files in a real folder, you can't use this method.<br>
Comments are normally entered by clicking on ''Comment''. This way they are stored in VFS files.
To comment files in a real folder, you may use comment files.<br>
Files of this kind are not listed, but if correct URL is supplied, they can be downloaded.
There are 2 kinds of comment files: per-file and single comment files.


==Per-file comment 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.
Per-File comment files contain the comment for a single file.
 
To use comment files, you need to do only 3 things:
There are 2 kinds of comment files:
 
== Single-comment files ==
For every file listed, HFS checks the existance 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.
 
Let say you have to comment the file '''test.zip''', you got to
* create a new text file,
* create a new text file,
* put the comment in it,
* put the comment in it,
* save the file as [filename].comment
* save the file as '''test.zip.comment'''
[filename] means the name of the file to be commented, so for example to comment file
 
'''test.zip''', your comment file would be '''test.zip.comment'''
The single-comment file must reside in the same folder of the commented file.
 
; Notice
: single comment files can be disabled with the option '''''Menu &rarr; Virtual File System &rarr; Load single comment files'''''. It is enabled by default. If you disable it, then any ''.comment'' file will be listed.
 
== Multi-comment files ==
This method work only on real-folders.
 
In the folder relative to your real-folder, you have to create a file ''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>
3 comments, 3 lines, it's easy.


==Single comment files==
; Notice : don't leave empty spaces before equal sign ('''=''').
In real-folders, you can create a file '''hfs.comments.txt'''<br>
Each line in this file is in the format filename=comment, so you can specify comments for many files, but all must reside in that folder.<br>
Notice: don't leave empty spaces before equal sign (=) .<br>
<br>
Single comment files can be disabled with the option Virtual File System -> Load single comment files.
It is enabled by default. If you disable it, then any file.comment will be listed.

Revision as of 00:29, 16 April 2006

Comments are normally entered by clicking on Comment. This way they are 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.

There are 2 kinds of comment files:

Single-comment files

For every file listed, HFS checks the existance 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.

Let say you have to comment the file test.zip, you got to

  • 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 of 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 will be listed.

Multi-comment files

This method work only on real-folders.

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

Notice
don't leave empty spaces before equal sign (=).