Re: Organization of files

Hi Becky,

Michael C. can probably say more about this, however, my assumption would
be that a POC or recommendation on your own branch could be illustrated in
a way that it is easiest for you. If I were approached with a POC that
required reorganization of the current sub-directory structure I would be
inclined to put everything in the index.html file of the appropriate
directory of a new in a new "test" directory within the context of a forked
repo and in my own branch.

Hope this is helpful. Feel free to reach out if what I am saying isn't
clear or you could use some help.

Thanks for your hard work on this!
Thaddeus

On Fri, Jun 1, 2018 at 4:31 PM, Becky Gibson <becky@knowbility.org> wrote:

> I have been trying to work on my action item for the personalization task
> force.  My understanding is that we want to separate the help and support
> terms and descriptions from the actual examples.  That seems easy enough
> except that it appears that I can only import an entire file via the
> data-include attribute.  Thus, in order to separate out the different
> sections, I need to split apart the files for each of the help types
> (alternative.html, easylang.html, etc).  Please correct me if I am wrong.
>
>
> For example, alternative.html would become alternative-desc.html, and
> alternative-example.html.  That also raises the question of where do the
> list of values applicable to each term belong? Currently the values are
> listed within the characteristcs  with the example because the examples
> assume an attribute/value pair.
>
> Should I go ahead and split up each of the appropriate files within the
> help subdirectory into two separate files? I would use the
> <filename>-desc.html and <filename>-example.html naming convention?  The
> <filename>.html can be pull in the two separate pieces into the whole
> (although I haven’t quite figured out how, yet). I would be happy to use a
> different approach.
>
> My idea for the organization for section 3, Vocabulary, of the help and
> support document is:
>
> 3 Vocabulary (may need to change this term)
> General Description
>
> 3.1 Alternative
> Alternative description
>
> 3.x <term>
> <term> description
>
> 4 Values (May need to change this term)
> Values description
>
> Values table (currently listed under 3.4.4 and 3.4.9 - I suggest putting
> them all in one place and referencing them as needed)
>
> 5 Examples
> 5.1 Alternative example
> 5.1.1 Alternative Characteristics (where needed) include the supported
> values within the characteristics.
>
> 5.2 <term> Example
>
> I tried to change the files around to show this for one example but I am
> not enjoying learning the w3c/respec rules.
>
> -becky
>
>
>
>
>
>
>
>