Gpc-doc

gpc-doc@gnu.de

53 discussions

Test
by Frank Heckenbach 28 Jun '03

28 Jun '03

Another test. Frank -- Frank Heckenbach, frank(a)g-n-u.de, http://fjf.gnu.de/, 7977168E GPC To-Do list, latest features, fixed bugs: http://www.gnu-pascal.de/todo.html GPC download signing key: 51FF C1F0 1A77 C6C2 4482 4DDC 117A 9773 7F88 1707

1 0

Test
by Frank Heckenbach 28 Jun '03

28 Jun '03

Just a test, please ignore. (Trying to get the archives running again.) Frank -- Frank Heckenbach, frank(a)g-n-u.de, http://fjf.gnu.de/, 7977168E GPC To-Do list, latest features, fixed bugs: http://www.gnu-pascal.de/todo.html GPC download signing key: 51FF C1F0 1A77 C6C2 4482 4DDC 117A 9773 7F88 1707

1 0

GPC docs writing team
by Mirsad Todorovac 25 May '03

25 May '03

Hi, all! I wanted to know about the GPC documentation writing group Frank told me about. He noted how we must watch not to duplicate the work. So, I'm using this occassion to contact you on the list, to see whether I can get an assignment to get all this done. As for myself, there occured about some clarifications about shl and shr that could be done, so if nobody has an objection, I think I could take this for start. Of course, I plan to offer everyting to the list for review/revision, unless it's too much work for everybody; in which case we can do what we agree upon. So, to translate, I'd like to write some clarification about shr and shl and I think I can already use some things I wrote from earlier discussions, so tell me what you think about it. // Please pardon my (I guess) (somewhat and sometimes) broken English, // since English is my second language. Thanks, Mirsad -- "I have a dream!" -- Martin Luther King Jr. "You can't hold someone down ... without staying down with him." -- Booker T. Washington "... one thing is for sure about the rat race: Even if you win, you're still a rat." -- S. Baars

3 3

Re: Doc changes GPC
by Mirsad Todorovac 07 May '03

07 May '03

On Sat, 3 May 2003, Frank Heckenbach wrote: > > BTW, I thought of making [Example]s follow-able in "Highlights" section. > > Can this be done without much hassle? > > They are in the HTML output (via `examplehref'). I don't think > there's any way to link to external (plain-text, or Pascal) files > from Info, DVI, PS or PDF. > > Frank BTW, Frank, have you seen the HTML-ized listings (done by their LXR) at http://lxr.mozilla.org/ ?? What do you think -- I think generating cross-refs and line numbers is a piece of cake, such as seen at http://lxr.nozilla.org/mozilla1.0/source/jpeg/example.c Also I had dillemas about generating and including texinfo source for all examples mentioned as examples or something else. Especially since source may not always be available, and users are sometimes l@zy ... Even not that. I.e. at home, at my mandrake box, I had gpc docs only, and alas no internet connection -- this sort of situation can happen to people who are not online. (I switched the reply to gpc-doc(a)gnu.de, so you don't get two messages.) Mirsad -- "I have a dream!" -- Martin Luther King Jr. "You can't hold someone down ... without staying down with him." -- Booker T. Washington

2 3

Question Re: GPC website docs 4 online browsing
by Mirsad Todorovac 05 May '03

05 May '03

Hi, Frank, others! I wondered whether we could change what is seen on http://www.gnu-pascal.de/gpc-hr/index.html in that way that Croatian text comes first, or after the "Short Contents" section? This way, it took me time to even think that something is bellow the long "Table of Contents", which includes even "Alphabetical language reference"? Alternativelly, there could be some link leading to main chapter of docs in some more intuitive way ... Thanks, Mirsad -- "I have a dream!" -- Martin Luther King Jr. "You can't hold someone down ... without staying down with him." -- Booker T. Washington

3 3

Test, please ignore
by Mirsad Todorovac 02 May '03

02 May '03

I've just subscribed. Testing. M. -- "I have a dream!" -- Martin Luther King Jr. "You can't hold someone down ... without staying down with him." -- Booker T. Washington

1 0

`True' and `False'
by Frank Heckenbach 31 Mar '03

31 Mar '03

When updating the documentation, Peter N Lewis and I came to the problem how to describe the Boolean values `True' and `False'. Peter suggested "true (conforming to reality) and false (different from reality", but I think "reality" is not a good term here (what do computer programs have to do with reality, anyway ;-). Perhaps the only thing that can be said is that there are two values, true and false, and that one is the opposite of the other. But they have some certain meanings as conditions in `if' and loops, and in expressions like `x = 2'. Does anyone have a useful description without being selfreferential and without referring to "reality"? BTW, ISO 10206 contains things like these: : The Booleantype shall be an ordinaltype. The values : shall be the enumeration of truth values denoted by the required : constantidentifiers false and true, such that false is the predecessor : of true. The ordinal numbers of the truth values denoted by false and : true shall be the integer values 0 and 1 respectively. : The operator in shall yield the value true if : the value of the operand of ordinaltype is a member of the value of the : settype; otherwise, it shall yield the value false. : If the Booleanexpression of the ifstatement yields the value true, the : statement of the ifstatement shall be executed. If the Booleanexpression : yields the value false, the statement of the ifstatement shall not be : executed, and the statement of the elsepart, if any, shall be executed. Frank -- Frank Heckenbach, frank(a)g-n-u.de http://fjf.gnu.de/ GnuPG and PGP keys: http://fjf.gnu.de/plan (7977168E)

3 3

Removing the user input forms
by Frank Heckenbach 11 Mar '03

11 Mar '03

Some weeks ago, I've installed the user input forms on the GPC web pages. Unfortunately, they've not proven too useful yet. The only entries of the intended kind came from Richard Jackson who suggested the forms initially ... Many of the other entries were silly stuff ("Micky Mouse" etc.). Some mistook the forms for a kind of "guestbook". The remaining ones were questions or discussion items. While not useless, they're probably better served by the mailing lists where more interested people will read them (in contrast to the web pages where only those who visit the page again will read it, and I guess many regular users only visit a few pages regularly). Maybe the text above the form isn't clear enough (but maybe it is, and people just don't read it; they see a form and just write whatever they have in mind ...). But as it's now, I don't think the forms are really useful. Therefore, unless someone has an idea how to "rescue" them, I'm afraid they'll be gone in a few days ... Frank -- Frank Heckenbach, frank(a)g-n-u.de http://fjf.gnu.de/ GnuPG and PGP keys: http://fjf.gnu.de/plan (7977168E)

4 4

Re: More on documentation tool
by Richard D. Jackson 02 Mar '03

02 Mar '03

On Fri, 2003-02-28 at 15:09, Frank Heckenbach wrote: <big snip> > > 1) When moving the vars into the section in which they are declared > > should I make a menu entry for each one or should I do a submenu of > > vars? > > Good question. I'd say it depends. Sometimes, each one deserves its > own entry, other times, there are a list of them which belong > together (e.g., the color constants in the CRT unit). > > Of course, the program can't find this out automatically. One rule > might be, if there's a comment for each of them, put them in > separate sections, like here: > > var > { Address of the lowest byte of heap used } > HeapLow: PtrCard; asmname '_p_HeapLow'; external; > > { Address of the highest byte of heap used } > HeapHigh: PtrCard; asmname '_p_HeapHigh'; external; > > { If set to true, `Dispose' etc. will raise a runtime error if > given an invalid pointer. } > HeapChecking: Boolean; asmname '_p_HeapChecking'; external; > Yes the above is going to strait forward to implement. > But if there's only one comment at the top, put them in one section > all together: > > const > { Foreground and background color constants } > Black = 0; > Blue = 1; > Green = 2; > Cyan = 3; > Red = 4; > Magenta = 5; > Brown = 6; > LightGray = 7; > > Of course, in the indices, there should be entries for each of them. Now this is tricky: 1) What do you call the node/section for this list of vars/functions ect...? 2) You can't just assume that because there is not a comment that it belongs to what was above. If you do what happens for those cases where I haven't finshed writing the documentation for my code? I'm thinking that to solve this we are going to need a group command. Something like {@group group name} .... {@end group } Where 'group name' would be the name used for the section/node. And Yes I agree that every item needs to be placed in the index but what happens in the case where you don't want them all in the index. maybe a option to the @group command. > > > 2) If I where to put them in the section menu how about this menu sytle: > > > > @menu > > * MaxInt:: Const > > * SomeVar:: Var > > * SomeType:: Type > > * FuncFoo:: function > > * ProcFoo:: Procedure > > @end menu > > > > Or > > @menu > > * Const MaxInt:: > > * Var foo:: > > * Type foo:: > > * SomeFunc:: > > * SomeProc:: > > @end menu > > Since the left part of the menu corresponds to the node name, I > prefer the former, so the node name equals the identifier. > > BTW, you sent this mail personally, so I'm replying personally. If > it was meant for the list, feel free to forward and/or quote my mail > there. > Sorry about that.. This one is going to the group... > Frank Oh FYI I've started to work on a manual for pas2texi. As soon as I get it roughed in I will send a copy to the list. Richard

2 1

More on documentation tool
by Richard D. Jackson 28 Feb '03

28 Feb '03

Well I've spent some time to learn texinfo. Well I should say I've gone over it and think I understand how it works that is. Anyways there are a few things I want to achive before working on pas2texi. They are in order: 1) A sample of expected output from the program. This will serve as a guide when I start to code. It will also let us agree on what that output should be. 2) A some what complete manual for the program. Again this will serve as a guide when I start to code. It will also allow us argue and or discuss the implementation details. 3) Start coding. So as a start here is an initial draft of what I think the output should be. It is the texinfo source that you can use makeinfo to transform into info/html. So after you have had a chance to look at it lets talk about it and revise it to fit what we want as far as output goes that is. Richard

3 3

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

2006

2005

2004

2003

2002

2001

2000

Gpc-doc