Gentoo glossary page

koolgentoo · Posted: Fri Mar 25, 2005 9:23 pm Post subject: Gentoo glossary page

i couldnt find a gentoo specific glossary page. so i wondered if we could have a page dedicated to definitions for gentoo related terms.

the script should be able to compile a set(1 ocurrence of each word) of terms to be defined from 2 sources.

1. from the docs where the terms to be defined are marked by an xml tag.
2. from a repository contributed by gentoo users

<?xml version="1.0"?>
<gentoo>
<index>
<word />
<word />
</index>
</gentoo>

and then the glossary

<?xml version="1.0"?>
<gentoo>
<glossary>
<word>
<definition />
<link>
<description />
<url />
</link>
<link>
<description />
<url />
</link>
</word>
</glossary>
</gentoo>

an html page would contain links generated using the first xml doc. when clicking a word a new html page will be generated from the data read from the
coresponding word element from the second xml document.

there can be 26 instances of the 2nd xml doc. starting from a.xml, b.xml, c.xml,... z.xml....

i will find a feature like the above very useful to a new gentooist

_________________
// keep it simple!

kallamej · Posted: Sat Mar 26, 2005 8:02 pm Post subject:

Moved from Gentoo Forums Feedback.
_________________
Please read our FAQ Forum, it answers many of your questions.
irc: #gentoo-forums on irc.libera.chat

ciaranm · Posted: Sat Mar 26, 2005 8:49 pm Post subject:

XML? Why XML?

myuser · Apprentice Joined: 31 Jan 2004 Posts: 218

>>> XML? Why XML?

for the love of all that is sacred, why?

Earthwings · Posted: Sat Mar 26, 2005 10:47 pm Post subject:

Ignoring uninteresting technical issues, I think it's a good idea and would be nice to have. The japanese gentoo site already has a glossary, I think. It could be used as a starting point.

koolgentoo · Posted: Sun Mar 27, 2005 7:20 pm Post subject:

the reason i thought of xml was to split the info from the interfaces hence easier to maintain. doesnt neccesarily have to
be xml can even be a flat text file.

by splitting the glossary system to interface and data, anyone can update the data file.

balso with the xml we are defining a document type and i believe it is a good idea for software systems to operate on predefined document types just like data types in programming languages.

an xml doc type and software systems to operate on this doc type is parallel to erm... data and methods => class

_________________
// keep it simple!

ciaranm · Posted: Sun Mar 27, 2005 9:06 pm Post subject:

Ok, so we all agree that a glossary is probably helpful and that XML sucks? Good.

(Incidentally, it is now official Gentoo policy that XML sucks.)

koolgentoo · Posted: Sun Mar 27, 2005 9:17 pm Post subject:

if you can give the reason why xml sucks then we might be able to understand your point. but to make a statement without reasoning how we to understand what you mean.

the immediate thing that comes to mind is that xml dom uses lot of memory!

r u not comfortable with tree datatype based algorithms, coding??? or you dont like the letters x, m and l?

come on man you say you are a developer so where is the logic behind your argument?
_________________
// keep it simple!

ciaranm · Posted: Sun Mar 27, 2005 9:24 pm Post subject:

koolgentoo · Posted: Sun Mar 27, 2005 9:29 pm Post subject:

again the lack of evidence! if i were you i would have placed a link to that document. i think some people here need grow up a little bit work on their reasoning

_________________
// keep it simple!

ciaranm · Posted: Sun Mar 27, 2005 9:34 pm Post subject:

koolgentoo · Posted: Sun Mar 27, 2005 9:44 pm Post subject:

when i debate i reason and have the facts available for others! we cannot waste time on debating like 10 year olds!!!!! all i am interested in is to see why you say xml sucks.

just in case if you have forgotten where glep 34 is then click HERE
_________________
// keep it simple!

dol-sen · Posted: Sun Mar 27, 2005 11:28 pm Post subject:

I found this by googling: Reasons XML Sucks.

koolgentoo · Posted: Mon Mar 28, 2005 4:42 pm Post subject:

thanks for your comments guys! dol-sen thanks for your effort i apreciate that. when i asked why xml sucks,

, what i meant was why xml sucks to use it to generate a glossary system.

i like open source which also means open standards.

ok, i'll start some work on the glossary system. starting with a spec. and let others improve/modify it the way they think is best.
_________________
// keep it simple!

Earthwings · Posted: Mon Mar 28, 2005 4:55 pm Post subject:

Mhm, what about using simple BBCode (to put it in the forums) or GuideXML? The content won't change that much, everything else would be overkill IMHO.

ciaranm · Posted: Mon Mar 28, 2005 5:36 pm Post subject:

If it ends up as glossary.gentoo.org then the generated content will be GuideXML, but the backend is probably best as flat text files.

koolgentoo · Posted: Tue Mar 29, 2005 11:48 am Post subject:

guideXML wow! i have gotta lot of docs to study! ok so i'll leave the initial work to ciaran or anybodyelse as i have not been using gentoo that long.

all i have in mind is to improve and make gentoo easier for new comers because i like the gentoo philosophy very much.

ciaran, i am sorry if i have offended you in anyway! i'll get you something from the buy me stuff list

probbably a usb pen?
_________________
// keep it simple!

ciaranm · Posted: Tue Mar 29, 2005 5:18 pm Post subject:

codergeek42 · Posted: Tue Mar 29, 2005 5:34 pm Post subject:

masseya · Posted: Tue Mar 29, 2005 6:17 pm Post subject:

What kind of scope would this glossary have? Are we talking about just Gentoo terminology (such as things like ebuild, portage and, ironically, guidexml) or would this include other linux terms?
_________________
if i never try anything, i never learn anything..
if i never take a risk, i stay where i am..

Earthwings · Posted: Tue Mar 29, 2005 6:25 pm Post subject:

Anything other than gentoo terms is pretty much covered by google (especially google's define: <term> feature).

psyqil · Advocate Joined: 26 May 2003 Posts: 2767

OMG! You're right, google has no idea:

koolgentoo · Posted: Tue Mar 29, 2005 7:56 pm Post subject:

yeah go for it ciaranm. i read your GLEP 34 and it looked very formal so i'll leave that to you then.

yes the scope is gentoo only. every term unknown outside the gentoo community. i have already compiled a subset for my benefit. i'll post it as soon as i have transfered it from my work pc.

also a procedures page would be very handy, relating to gentoo project. a hierachical organisation would make searching easy for any one wants to know how we do something at gentoo.org. OH no no no i am not talking XML here! only the user interface is hierachical.

if we bear, making gentoo easier to learn for everyone, in mind then we wont go wrong
_________________
// keep it simple!

ciaranm · Posted: Tue Mar 29, 2005 8:03 pm Post subject:

koolgentoo · Posted: Tue Mar 29, 2005 8:27 pm Post subject:

what i meant was that your style of doc writing is better than mine which i noticed whilst reading glep 34
_________________
// keep it simple!