[HECnet] HECnet .HLP library for OpenVMS

[Sampsa Laine]

Also it's VERY easy to parse YAML as there are libraries for basically every language in use to do it.

So I'd rather use that than Github Markup..

Sampsa


On 9 Sep 2015, at 16:36, Sampsa Laine <sampsa at mac.com> wrote:

> The original idea is that it's basically the same format as a VMS help file but we'll use some markup to make it more generic, then export VMS HELP files, Wiki markup etc.
> 
> YAML will work fine for this.
> 
> If we keep over-engineerin this thing I doubt anything will ever be built..
> 
> I vote we use YAML and agree on the tags we use to structure the text.
> 
> Sampsa
> 
> 
> On 9 Sep 2015, at 16:32, Mark Pizzolato - Info Comm <Mark at infocomm.com> wrote:
> 
>> On Wednesday, September 9, 2015 at 8:12 AM, Peter Jackson wrote:
>>> For a known standard form of markup, I suggest looking at YAML, which is
>>> stable and has libraries implemented in a number of languages.
>>> 
>>> See HTTP://YAML.ORG
>>> 
>>> I think it is very important to make the barrier to authors as low as possible
>>> and YAML strikes me as meeting this requirement.
>> 
>> Well, if the only goal was to transport/exchange the explicit 'words' contained in the text of help (or other) information, YAML would work.
>> 
>> However, the data I've seen contains information which is usefully displayed in tabular arrangements (at least in columns) with varying useful indentation.
>> 
>> When I looked at this problem I started looking at "Markdown" and "Github Flavored Markdown".
>> 
>> The "pandoc" tool seemed to provide translations from many formats to many others.
>> 
>> - Mark
>> 
>>> On 09/09/2015 14:28, Sampsa Laine wrote:
>>>> So any suggestions for markup?
>>>> 
>>>> I've been playing around with this in my head and thought that maybe
>>> something like this could work..
>>>> 
>>>> - Any line starting with three pipe symbols is a "command"
>>>>  For example:
>>>> 	|||ENTRY_START
>>>> 	|||ENTRY_END
>>>> 		We can use these to have multiple documents
>>>> 		in one file
>>>> 
>>>> 	|||TITLE|HILANT:: VAXcluster	Title of the entry
>>>> 	|||DATE|1-JAN-2015		Date of document
>>>> 	|||VERSION|1.01			Version of document
>>>> 	|||AUTHOR|Sampsa Laine
>>>> 	|||AUTHOR_MAIL11|HILANT::SAMPSA
>>>> 	|||AUTHER_SMTP|sampsa at mac.com
>>>> 
>>>> 	|||H|1|This is a heading	Heading level, 1, Name
>>>> 	|||SECT_START			Start of text section
>>>> 	|||SECT_END			End of section
>>>> 		Analogous to<p>...</p>  in HTML
>>>> 
>>>> 	|||HTTP_LINK|http://www..|Link description
>>>> 		(like<a href="http://..">Decription</a>  in HTML)
>>>> 
>>>> 	|||FAL_LINK|CHIMPY::[INFO]FOO.TXT|Link description
>>>> 		Same as HTTP link but with a reference to an object
>>>> 		on HECnet - not sure how to use this right now, maybe
>>>> 		produce some kind of menu to interesting documents on
>>>> 		HECnet
>>>> 
>>>> 	|||CTERM|HILANT|Description
>>>> 		Again, not sure exactly how to use this but could be used
>>>> 		to generate a menu like LAUNCH on CHIMPY
>>>> 
>>>> 
>>>> 
>>>> 
>>>> On 8 Sep 2015, at 16:59, Sampsa Laine<sampsa at mac.com>  wrote:
>>>> 
>>>>> Another side benefit of the Wiki of course is that we can put a bunch of
>>> other "HOWTO"-type material, history of the network, people can have their
>>> own entries (i.e. who is this HILANT::SAMPSA guy)..
>>>>> 
>>>>> My hosting provider provides it for free with a one click install and does
>>> automatic updates whenever a new version is released etc..
>>>>> 
>>>>> Of course if someone else wants to host it they're welcome to do so, just
>>> saying that I have this facility.
>>>>> 
>>>>> PS: MediaWiki needs a  logo and I'm having a graphic designer buddy work
>>> of an ASCII logo of the word HECnet in about a 70x15 character size to be
>>> displayed on text terminals - if everybody agrees, we can turn that into a
>>> PNG etc and use it for various things such as the Wiki.
>>>>> 
>>>>> Sampsa
>>>>> 
>>>>> 
>>>> 
>> 
>> 
> 
> _______________________________________________
> Hecnet-list mailing list
> Hecnet-list at lists.sonic.net
> https://lists.sonic.net/mailman/listinfo/hecnet-list

-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 841 bytes
Desc: Message signed with OpenPGP using GPGMail
URL: <http://lists.sonic.net/pipermail/hecnet-list/attachments/20150909/75860ab4/attachment.sig>