[oXygen-user] Master Files vs Main Files

[Eliot Kimber]

Sounds like a very useful feature.

I think I would prefer master or root over "main". Root is of course the
more DITA-ish term but I suspect "master" would be more understood, at least
for documentation-focused people.

Cheers,

E.

On 2/29/12 2:51 PM, "George Cristian Bina" <george at oxygenxml.com> wrote:

> Let me try to explain a little more this new addition.
> 
> We already have validation scenarios that resolve the usecase of working
> on a module by allowing to specify that the validation should start from
> a different file than the one you are editing, a file that refers the
> current file in some way (for example by including or importing that).
> 
> This works ok but it is not dynamic. If the links (import/include
> relations) between the files change then you need to manually update the
> validation scenarios to match those changes.
> 
> So, instead of specifying validation scenarios for a module we thought
> that it will be a lot easier for the user to just mark the
> main/master/principal/core/root files and have oXygen automatically
> discover that you are editing a module, if the edited file can be
> reached from such a marked file through include/import/reference links
> and validate that file automatically instead of validating the current
> file. Of course, if there are more master/main/etc. files that include a
> module the validation will validate all of them.
> 
> Marking these files can be done with a contextual action, for example we
> can add a "Set as main file" action on the contextual menu.
> 
> We thought that will be interesting to gather all these marked files
> together, in the project, and we created a logical folder inside the
> project called "Master files" or "Main files" or some other maybe better
> name that will contain all these files. This syntetic folder can contain
> also other logical folders thus allowing to organize these files in
> different groups.
> 
> If you organize your project like this then it makes sense to be able to
> easily trigger validate and transformation actions on these files (we
> will allow to associate more transformation scenarios with one file (to
> allow easy conversion from a single file to different output formats for
> example). However, it is not the fact that you can trigger actions the
> most important thing about these files, what it is important is that
> they are not modules, they do not depend on other files.
> 
> We incline to name these "main files" taking into account the
> development languages like Java or C++ where you have a main class and a
> main method for example and that is the entry point for an application.
> We have seen also the "master" term used, I think Tavi (Octavian)
> mentioned to me that he has seen that in relation with a DocBook
> document where the file that included different DocBook fragments (as
> entities or XInclude) was referred to as the DocBook master file - thus
> the "master files" name.
> DITA names the DITA map that provides the context for resolving keys as
> "root map", so "root files" seems also a possible option.
> 
> Best Regards,
> George
> --
> George Cristian Bina
> <oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
> http://www.oxygenxml.com
> 
> On 2/29/12 7:07 PM, David Cramer wrote:
>> -----BEGIN PGP SIGNED MESSAGE-----
>> Hash: SHA1
>> 
>> I think the term needs to be more generic. I could imagine having more
>> than one of these folders. E.g. one for files that need to be
>> bulk-built and another for files that need to be bulk-validated.
>> 
>> "Action folders" maybe? I.e. folders that can be associated with actions.
>> 
>> David
>> 
>> On 02/29/2012 05:33 AM, mozer wrote:
>>> Core Files ?
>>> 
>>> Xmlizer
>>> 
>>> On Wed, Feb 29, 2012 at 11:50 AM, Octavian Nadolu
>>> <octavian_nadolu at sync.ro<mailto:octavian_nadolu at sync.ro>>  wrote:
>>> 
>>> Hello,
>>> 
>>> We want to add a new concept in<oXygen/>  consisting in a new type
>>> of folder in the Project view where the user can add the files that
>>> must be validated and transformed for the current project. The
>>> folder must contain only the main/master modules. For example, if
>>> you have a project that contains the XHTML 1.1 schemas you need to
>>> add only the main module "xhtml11.xsd" in this folder. If you have
>>> a DITA project you need to add in this folder the dita maps that
>>> must be transformed.
>>> 
>>> What name do you think will describe better this concept, "Master
>>> Files" or "Main Files"? Do you have other suggestions?
>>> 
>>> Regards, Octavian -- Octavian Nadolu<oXygen/>  XML Editor
>>> http://www.oxygenxml.com
>>> 
>>> _______________________________________________ oXygen-user mailing
>>> list oXygen-user at oxygenxml.com<mailto:oXygen-user at oxygenxml.com>
>>> http://www.oxygenxml.com/mailman/listinfo/oxygen-user
>>> 
>>> 
>>> 
>>> 
>>> _______________________________________________ oXygen-user mailing
>>> list oXygen-user at oxygenxml.com
>>> http://www.oxygenxml.com/mailman/listinfo/oxygen-user
>> 
>> -----BEGIN PGP SIGNATURE-----
>> Version: GnuPG v1.4.11 (GNU/Linux)
>> Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
>> 
>> iQEcBAEBAgAGBQJPTls/AAoJEMHeSXG7afUhIykIAJ5CJDhxcreUWQPCjy2vFI61
>> bkTdHPUqPPdGpnonLCAG8Qr9GrMOBjHCxtkUp7wFMhaAmGshvaSR7vzXtGiwazaN
>> bddqPbmiGqu7ax7xI+rnu109o0Hptk7enhM7vRPy+rET7Vz7+im3x8svI+NHiE08
>> q8+eciTddA/5m1yGIjsq4hbh6jr8lifSc51xwEDWbpImjqlJzTyb8Zy9AaIPu6/l
>> /0wlm+khxVTpaP/tOnloruBWCKEIxsEUNtmsDvHCHxYoRI8N5ah/fNzdvxkjoGbA
>> ilzoJdDBf+Pg/bN5Lk+sDS2iuT4IYfHX9n+JuOoFHk7kKPBtDtmSOpAYPxx19wg=
>> =2oRs
>> -----END PGP SIGNATURE-----
>> _______________________________________________
>> oXygen-user mailing list
>> oXygen-user at oxygenxml.com
>> http://www.oxygenxml.com/mailman/listinfo/oxygen-user
>> 
> _______________________________________________
> oXygen-user mailing list
> oXygen-user at oxygenxml.com
> http://www.oxygenxml.com/mailman/listinfo/oxygen-user

-- 
Eliot Kimber
Senior Solutions Architect
"Bringing Strategy, Content, and Technology Together"
Main: 512.554.9368
www.reallysi.com
www.rsuitecms.com