Re: Conversion text in documentation

Hi Andrea!

On Wed, 27 Oct 2021 09:06:07 +0200
Andrea Tosoni <[email protected]> wrote:

> Hello,
>=20
> sorry : I'm asking if these modules can be a candidate to be posted on CP=
AN.
>=20

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/FAQ=
_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-formats/=
 .

HTH.

> Best regards,
>=20
>                Andrea
>=20
>=20
> Il giorno mer 27 ott 2021 alle ore 08:53 Shlomi Fish <shlomif@shlomifish.=
org>
> ha scritto:
>=20
> > Hi Andrea!
> >
> > On Mon, 25 Oct 2021 21:41:21 +0200
> > Andrea Tosoni <[email protected]> wrote:
> > =20
> > > Hello,
> > >
> > > I'm Andrea Tosoni.
> > >
> > > Some years ago I started to write some perl scripts because I don't l=
ike =20
> > to =20
> > > 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 fin=
e.
> > > =20
> >
> > I read your message, but I don't understand what you wish to ask. What =
is
> > the
> > dilemma?
> > =20
> > > I started from POD idea: merge code and documentation. I added the
> > > possibility to load parameters from an external file or by constants
> > > defined in my code (VHDL or Verilog or some other language). I can al=
so
> > > 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 the
> > > 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 export =
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 =20
> > coverage =20
> > > 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 =20
> >
> >
> >
> > --
> >
> > Shlomi Fish       https://www.shlomifish.org/
> > https://shlomifishswiki.branchable.com/Self-Sufficiency/
> >
> > Chuck Norris killed all the members of the Spanish Inquisition, so they
> > won=E2=80=99t
> > come unexpectedly.
> >     =E2=80=94 http://www.shlomifish.org/humour/bits/facts/Chuck-Norris/
> >
> > Please reply to list if it's a mailing list post - https://shlom.in/rep=
ly
> > .
> > =20



--=20

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 wo=
uld
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 .