Hi Vailton,
On 2010 Feb 21, at 00:15, Vailton Renato wrote:
> Hi all!
>
> I have a question that I found when I studied about documentation on
> NF format and I still can not completely understand: What name we give
> to new files containing the documentation on SVN?
>
> * Respecting the category of functions?
> * Respecting the category + subcategory?
> * There is no specific rule?
>
> Recalling that this type of nomenclature is important just to keep a
> certain "order" in the repository so it will be easy to find and
> compare the translation between languages of a specific function...
> because after exporting this data to other formats (web, pdf, etc.)
> this detail may not seem so important.
Good point. There is no specific rule yet.
I think it's better to categorize functions
only using keywords ("tags") inside doc, otherwise
we will have to keep filenames in sync with
file content, which in practice will mean a lot
cleanup work, and it will never be right.
So, maybe the easiest is to create doc filenames
from the _beginning_ of functions names (or class
names) contained in them:
/doc/en/a.txt - containing all A*() functions.
/doc/en/bit.txt - containing HB_BIT*() functions.
/doc/en/hb_f.txt - containing HB_F*() functions.
/doc/en/hb_os.txt - containing HB_OS*() functions.
/doc/en/ord.txt - containing ORD*() functions.
/doc/en/tbrowse.txt - containing TBROWSE() class.
/contrib/hbsqlit3/doc/en/sqlite3.txt - containing all SQLITE3_*() functions.
The 'beginning' can the first letter, or first
logical section ("namespace"), of the functions
names. (If this is doubtful I can create more
examples)
This will also create a certain level of
natural categorization, since our name are
usually well formed, and it makes finding
any functions very easy, without the need to
grep or do any other sort of multi-file search.
Opinions are welcome.
Brgds,
Viktor
_______________________________________________
Harbour mailing list (attachment size limit: 40KB)
Harbour@harbour-project.org
http://lists.harbour-project.org/mailman/listinfo/harbour
