Ok... this might take a few iterations before we have something we can agree on.

As a first draft, I visited
https://www.jsoftware.com/help/dictionary/dqco.htm in chrome and used
right click Save As... with Format: Webpage, Complete and saving it
under the name dqco.htm on my machine.

Then, I went into the resulting dqco_files folder and edited the copy
of jdoc.css there, adding a line at the bottom:

.caution {float: right}

I also created a javascript file named caution.js in that folder with
this content:

let firstHR= document.getElementsByTagName('hr')[0];
let newAnchor= document.createElement('a');
let newHref= document.createAttribute('href');
newHref.value= 'https://code.jsoftware.com/wiki/Vocabulary/ObsoleteSyntax';
newAnchor.setAttributeNode(newHref);
let newClass= document.createAttribute('class');
newClass.value= 'caution';
newAnchor.setAttributeNode(newClass);
newAnchor.appendChild(document.createTextNode('caution'));
document.body.insertBefore(newAnchor, firstHR);

Finally, I added to the bottom of my local dqco.htm file as the
second-to-last line:

<script src="./dqco_files/caution.js" ></script>

This gives me a caution link in the upper right hand corner of that
page which links to the obsolete syntax page.

Keep in mind that this is only a first draft and some of this would
obviously have to change before it could be used for real.

Key questions to consider:

(1) Does this look suitable from a user perspective?

(2) Does this procedure look close to plausible from an admin
perspective? (Would it be preferable to add the corresponding html
fragment before the first hr? Or is this separation of concerns closer
to ideal?)

(I was looking at doing this entirely in css, but adding links to html
documents via css is considered an "exploit" -- javascript is
considered "more secure" than css.)

(3) How do we decide which pages should get this proposed update?

Thanks,

-- 
Raul

On Tue, Sep 21, 2021 at 10:31 PM Henry Rich <[email protected]> wrote:
>
> I have created the page
> code.jsoftware.com/wiki/Vocabulary/ObsoleteSyntax .  Now let's fix up
> those old pages to point to it.
>
> Henry Rich
>
> On 9/21/2021 8:12 PM, Raul Miller wrote:
> > Thinking about this a bit further, there are several "models" that we
> > could choose from, for adding navigation to historical pages,
> > including:
> >
> > (*) The "errata" model, where the links are supplemental, perhaps with
> > a single link added to the navigation of all relevant pages or perhaps
> > simply linked from a landing page for the dictionary.
> >
> > (*) The "footnote" model, where the links are appended to the bottom
> > of the page, perhaps with a heading such as "See Also" or "Updates" or
> > even "Footnotes".
> >
> > (*) The "advertising" model, where the links are inserted into the
> > page, perhaps at a fixed position or perhaps using a rollover or
> > slide-in mechanism. (This one requires javascript and/or css -- but if
> > we only concern ourselves with popular recent browsers we might even
> > be able to throw everything into jdoc.css. For example.)
> >
> > Other approaches are also possible but probably less desirable (such
> > as updating the "top jump" and/or "bottom jump" nav).
> >
> > That said, ... right now this is all hypothetical, because we do not
> > have adequate documentation for obsolete syntax in nuvoc. And, the
> > structure and quality of that documentation should inform our approach
> > for tying it to the dictionary.
> >
> > Thanks,
> >
>
>
> --
> This email has been checked for viruses by AVG.
> https://www.avg.com
>
> ----------------------------------------------------------------------
> For information about J forums see http://www.jsoftware.com/forums.htm
----------------------------------------------------------------------
For information about J forums see http://www.jsoftware.com/forums.htm

Reply via email to