Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [platform-help-dev] Eclipse help naming conventions.

We do not have any special conventions for help files, topics, ids.  You
should be able to name them freely, with few obvious exceptions:  do not
use "." as part of context id, do not use "#" as part of file name.

Do you think there is any danger in not having guidlines for help?  I do
not see any potential for conflicts between help files in different
plugins.

Konrad Kolosowski
Eclipse Help System



                                                                                                                                              
                      "Pomeroy, Christal"                                                                                                     
                      <cpomeroy@xxxxxxxxxxxx>         To:       platform-help-dev@xxxxxxxxxxx                                                 
                      Sent by:                        cc:                                                                                     
                      platform-help-dev-admin@        Subject:  [platform-help-dev] Eclipse help naming conventions.                          
                      eclipse.org                                                                                                             
                                                                                                                                              
                                                                                                                                              
                      07/15/2002 10:02 PM                                                                                                     
                      Please respond to                                                                                                       
                      platform-help-dev                                                                                                       
                                                                                                                                              
                                                                                                                                              



I note that there are general s/w file naming and extension point naming
conventions provided under 'eclipse project' > 'development'. Are there
help-related naming conventions (e.g., for help topic files, XML files,
infopops, context IDs, etc.) in existence or under development?

Best,
   Christal

Christal Pomeroy
Technical Documentation Mgr., RSG-Ottawa

R a t i O n a l
the software development company
770 Palladium Drive
Kanata, Ontario  K2V 1C8
www.rational.com

Office':  613.591.7944
Cell':     613.282.6417
Fax:         613.591.7020

-- You can't control the length of your life,
>     but you can control its width and depth. --
>
_______________________________________________
platform-help-dev mailing list
platform-help-dev@xxxxxxxxxxx
http://dev.eclipse.org/mailman/listinfo/platform-help-dev





Back to the top