Re: Conversion text in documentation
[email protected] (Andrea Tosoni) Wed, 27 Oct 2021 17:46:23 +0200
| Newsgroups | perl.module-authors |
|---|---|
| Message-ID | <CACWDS0AweMxqn_ERFdTp7SSyFiCCrGkCxyY60i1=zdg+AQMOZw@mail.gmail.com> |
--000000000000a53c5d05cf577f84
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Hello,
thank you.
My code is written in pure perl, mainly with Moose: I like object oriented
language because code is cleaner. So, no compilation is necessary and the
output is predictable.
Documentation is written at the end of each module with POD. One test is
dedicated to verify if all functions have their description.
I don't write malware :) and I try to have full code coverage with
automatic tests. I can't be sure that all is working fine, but I think that
it's a first step.
I will ask for an account and in the next day I will prepare the modules.
Working locally, normally I don't need a Makefile.PL to automate
installation and this is new for me to prepare.
Best regards,
Andrea
Il giorno mer 27 ott 2021 alle ore 17:02 Shlomi Fish <[email protected]=
g>
ha scritto:
> Hi Andrea!
>
> On Wed, 27 Oct 2021 09:06:07 +0200
> Andrea Tosoni <[email protected]> wrote:
>
> > Hello,
> >
> > sorry : I'm asking if these modules can be a candidate to be posted on
> CPAN.
> >
>
> AFAIK, one is allowed to upload any FOSS and non-malware code to CPAN.
> That put
> aside, I have collected some resources about sw quality guidelines:
>
> https://github.com/shlomif/Freenode-programming-channel-FAQ/blob/master/F=
AQ_with_ToC__generated.md#what-are-some-best-practices-in-programming-that-=
i-should-adopt
>
> ; I also wrote about the overwhelming state of doc formats here:
> https://www.shlomifish.org/philosophy/computers/web/choice-of-docs-format=
s/
> .
>
> HTH.
>
> > Best regards,
> >
> > Andrea
> >
> >
> > Il giorno mer 27 ott 2021 alle ore 08:53 Shlomi Fish <
> [email protected]>
> > ha scritto:
> >
> > > Hi Andrea!
> > >
> > > On Mon, 25 Oct 2021 21:41:21 +0200
> > > Andrea Tosoni <[email protected]> wrote:
> > >
> > > > Hello,
> > > >
> > > > I'm Andrea Tosoni.
> > > >
> > > > Some years ago I started to write some perl scripts because I don't
> like
> > > to
> > > > re-made the same thing many times, especially when I have to write
> > > > documentation (I'm a hardware designer).
> > > >
> > > > In these years, scripts have become perl modules that work almost
> fine.
> > > >
> > >
> > > I read your message, but I don't understand what you wish to ask. Wha=
t
> is
> > > the
> > > dilemma?
> > >
> > > > I started from POD idea: merge code and documentation. I added the
> > > > possibility to load parameters from an external file or by constant=
s
> > > > defined in my code (VHDL or Verilog or some other language). I can
> also
> > > > calculate fields and iterate on lists or similar basic programming
> > > > operations.The markup is very easy. Documentation can be split in
> many
> > > > source files without order and it's merged at the end.
> > > >
> > > > I also added the possibility to load images (vectorial images for t=
he
> > > > moment) and create tables.
> > > >
> > > > Today my output is a Framemaker file (in my company it is the tool
> for
> > > > official documentation) but I think to add the possibility to expor=
t
> in
> > > > Latex (because I like) and Word (because I have to support it).
> > > >
> > > > I don't know if these modules can help somebody else.
> > > >
> > > > Today I have to rework to remove deprecated modules, increase test
> > > coverage
> > > > and add some missing functionalities and this can be the moment to
> > > > organize in official modules, if you think that can be useful.
> > > >
> > > > Thank you for reading my mail.
> > > >
> > > > Best regards,
> > > >
> > > > Andrea Tosoni
> > >
> > >
> > >
> > > --
> > >
> > > Shlomi Fish https://www.shlomifish.org/
> > > https://shlomifishswiki.branchable.com/Self-Sufficiency/
> > >
> > > Chuck Norris killed all the members of the Spanish Inquisition, so th=
ey
> > > won=E2=80=99t
> > > come unexpectedly.
> > > =E2=80=94 http://www.shlomifish.org/humour/bits/facts/Chuck-Norri=
s/
> > >
> > > Please reply to list if it's a mailing list post -
> https://shlom.in/reply
> > > .
> > >
>
>
>
> --
>
> Shlomi Fish https://www.shlomifish.org/
> https://youtu.be/KxGRhd_iWuE - Never Give Up!!
>
> Unix was not designed to stop you from doing stupid things, because that
> would
> also stop you from doing clever things.
> =E2=80=94 Doug Gwyn ( https://en.wikiquote.org/wiki/Unix )
>
> Please reply to list if it's a mailing list post - https://shlom.in/reply
> .
>
--000000000000a53c5d05cf577f84
Content-Type: text/html; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
<div dir=3D"ltr">Hello,<div><br></div><div>thank you.</div><div><br></div><=
div>My code is=C2=A0written in pure perl, mainly with Moose: I like object =
oriented language because code is cleaner. So, no compilation is=C2=A0neces=
sary and the output is predictable.=C2=A0</div><div><br></div><div>Document=
ation is written at the end of each module with POD. One test is dedicated =
to verify if all functions have their description.</div><div><br></div><div=
>I don't write malware :) and I try to have full code coverage with aut=
omatic tests. I can't be sure that all is working fine, but I think tha=
t it's a first step.</div><div><br></div><div>I will ask for an account=
and in the next day I will prepare the modules. Working locally, normally =
I don't need a Makefile.PL to automate installation and this is new for=
me to prepare.</div><div><br></div><div>Best regards,</div><div><br></div>=
<div>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Andrea</=
div><div><br></div><div><br></div><div><br></div></div><br><div class=3D"gm=
ail_quote"><div dir=3D"ltr" class=3D"gmail_attr">Il giorno mer 27 ott 2021 =
alle ore 17:02 Shlomi Fish <<a href=3D"mailto:[email protected]">sh=
[email protected]</a>> ha scritto:<br></div><blockquote class=3D"gmai=
l_quote" style=3D"margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,20=
4,204);padding-left:1ex">Hi Andrea!<br>
<br>
On Wed, 27 Oct 2021 09:06:07 +0200<br>
Andrea Tosoni <<a href=3D"mailto:[email protected]" target=3D"_=
blank">[email protected]</a>> wrote:<br>
<br>
> Hello,<br>
> <br>
> sorry : I'm asking if these modules can be a candidate to be poste=
d on CPAN.<br>
> <br>
<br>
AFAIK, one is allowed to upload any FOSS and non-malware code to CPAN. That=
put<br>
aside, I have collected some resources about sw quality guidelines:<br>
<a href=3D"https://github.com/shlomif/Freenode-programming-channel-FAQ/blob=
/master/FAQ_with_ToC__generated.md#what-are-some-best-practices-in-programm=
ing-that-i-should-adopt" rel=3D"noreferrer" target=3D"_blank">https://githu=
b.com/shlomif/Freenode-programming-channel-FAQ/blob/master/FAQ_with_ToC__ge=
nerated.md#what-are-some-best-practices-in-programming-that-i-should-adopt<=
/a><br>
<br>
; I also wrote about the overwhelming state of doc formats here:<br>
<a href=3D"https://www.shlomifish.org/philosophy/computers/web/choice-of-do=
cs-formats/" rel=3D"noreferrer" target=3D"_blank">https://www.shlomifish.or=
g/philosophy/computers/web/choice-of-docs-formats/</a> .<br>
<br>
HTH.<br>
<br>
> Best regards,<br>
> <br>
>=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 Andrea<br>
> <br>
> <br>
> Il giorno mer 27 ott 2021 alle ore 08:53 Shlomi Fish <<a href=3D"ma=
ilto:[email protected]" target=3D"_blank">[email protected]</a>&g=
t;<br>
> ha scritto:<br>
> <br>
> > Hi Andrea!<br>
> ><br>
> > On Mon, 25 Oct 2021 21:41:21 +0200<br>
> > Andrea Tosoni <<a href=3D"mailto:[email protected]" t=
arget=3D"_blank">[email protected]</a>> wrote:<br>
> >=C2=A0 <br>
> > > Hello,<br>
> > ><br>
> > > I'm Andrea Tosoni.<br>
> > ><br>
> > > Some years ago I started to write some perl scripts because =
I don't like=C2=A0 <br>
> > to=C2=A0 <br>
> > > re-made the same thing many times, especially when I have to=
write<br>
> > > documentation (I'm a hardware designer).<br>
> > ><br>
> > > In these years, scripts have become perl modules that work a=
lmost fine.<br>
> > >=C2=A0 <br>
> ><br>
> > I read your message, but I don't understand what you wish to =
ask. What is<br>
> > the<br>
> > dilemma?<br>
> >=C2=A0 <br>
> > > I started from POD idea: merge code and documentation. I add=
ed the<br>
> > > possibility to load parameters from an external file or by c=
onstants<br>
> > > defined in my code (VHDL or Verilog or some other language).=
I can also<br>
> > > calculate fields and iterate on lists or similar basic progr=
amming<br>
> > > operations.The markup is very easy. Documentation can be spl=
it in many<br>
> > > source files without order and it's merged at the end.<b=
r>
> > ><br>
> > > I also added the possibility to load images (vectorial image=
s for the<br>
> > > moment) and create tables.<br>
> > ><br>
> > > Today my output is a Framemaker file (in my company it is th=
e tool for<br>
> > > official documentation) but I think to add the possibility t=
o export in<br>
> > > Latex (because I like) and Word (because I have to support i=
t).<br>
> > ><br>
> > > I don't know if these modules can help somebody else.<br=
>
> > ><br>
> > > Today I have to rework to remove deprecated modules, increas=
e test=C2=A0 <br>
> > coverage=C2=A0 <br>
> > > and add some missing functionalities and this can be the mom=
ent to<br>
> > > organize in official modules, if you think that can be usefu=
l.<br>
> > ><br>
> > > Thank you for reading my mail.<br>
> > ><br>
> > > Best regards,<br>
> > ><br>
> > >=C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0 =C2=
=A0 =C2=A0 =C2=A0 =C2=A0 =C2=A0Andrea Tosoni=C2=A0 <br>
> ><br>
> ><br>
> ><br>
> > --<br>
> ><br>
> > Shlomi Fish=C2=A0 =C2=A0 =C2=A0 =C2=A0<a href=3D"https://www.shlo=
mifish.org/" rel=3D"noreferrer" target=3D"_blank">https://www.shlomifish.or=
g/</a><br>
> > <a href=3D"https://shlomifishswiki.branchable.com/Self-Sufficienc=
y/" rel=3D"noreferrer" target=3D"_blank">https://shlomifishswiki.branchable=
.com/Self-Sufficiency/</a><br>
> ><br>
> > Chuck Norris killed all the members of the Spanish Inquisition, s=
o they<br>
> > won=E2=80=99t<br>
> > come unexpectedly.<br>
> >=C2=A0 =C2=A0 =C2=A0=E2=80=94 <a href=3D"http://www.shlomifish.org=
/humour/bits/facts/Chuck-Norris/" rel=3D"noreferrer" target=3D"_blank">http=
://www.shlomifish.org/humour/bits/facts/Chuck-Norris/</a><br>
> ><br>
> > Please reply to list if it's a mailing list post - <a href=3D=
"https://shlom.in/reply" rel=3D"noreferrer" target=3D"_blank">https://shlom=
.in/reply</a><br>
> > .<br>
> >=C2=A0 <br>
<br>
<br>
<br>
-- <br>
<br>
Shlomi Fish=C2=A0 =C2=A0 =C2=A0 =C2=A0<a href=3D"https://www.shlomifish.org=
/" rel=3D"noreferrer" target=3D"_blank">https://www.shlomifish.org/</a><br>
<a href=3D"https://youtu.be/KxGRhd_iWuE" rel=3D"noreferrer" target=3D"_blan=
k">https://youtu.be/KxGRhd_iWuE</a> - Never Give Up!!<br>
<br>
Unix was not designed to stop you from doing stupid things, because that wo=
uld<br>
also stop you from doing clever things.<br>
=C2=A0 =C2=A0 =E2=80=94 Doug Gwyn ( <a href=3D"https://en.wikiquote.org/wik=
i/Unix" rel=3D"noreferrer" target=3D"_blank">https://en.wikiquote.org/wiki/=
Unix</a> )<br>
<br>
Please reply to list if it's a mailing list post - <a href=3D"https://s=
hlom.in/reply" rel=3D"noreferrer" target=3D"_blank">https://shlom.in/reply<=
/a> .<br>
</blockquote></div>
--000000000000a53c5d05cf577f84--