HFS: Comment files: Difference between revisions

From rejetto wiki
Jump to navigation Jump to search
No edit summary
 
m (Reverted edits by 216.127.153.145 (Talk); changed back to last version by Rejetto)
 
(17 intermediate revisions by 7 users not shown)
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 ensures they are then 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==
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).
Per-File comment files contain the comment for a single file.
To use comment files, you need to do only 3 things:
* create a new text file,
* put the comment in it,
* save the file as [filename].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'''


==Single comment files==
There are two kinds of comment files:
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>
== Single-comment files ==
Notice: don't leave empty spaces before equal sign (=) .<br>
For every file listed, HFS checks for the existence of a single-comment file.
<br>
This is a per-file method. If you want to use this method on three files, you need to create three single-comment files.
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.
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 &rarr;Virtual File System &rarr;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 <cite>test.zip=here goes my comment</cite>
 
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.

Latest revision as of 17: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.