ivoa-std / ivoatexdoc Goto Github PK
View Code? Open in Web Editor NEWLicense: Creative Commons Attribution Share Alike 4.0 International
License: Creative Commons Attribution Share Alike 4.0 International
Sec. 2.2.2 of ivoatexDoc mentions an ivoatex/startup.sh
script that ivoatex submodule does not (any longer?) include.
Maybe the ivoatex/make-template.sh
supersedes it?
Having performed a few of these and seeing what can happen, I still think there are some things to improve.
The doc-template can only really provide some default files that the original-repo does not: probably README.md and LICENSE and maybe a default workflow (have to check), which leads to two complications for the ivoa-std maintainer doing the migration:
So, that is a pain and probably makes the template mechanism offer so little that we should instead just require that the original-repo have a decent README and the LICENSE before going ahead with the migration. That also means that the author(s) have added the LICENSE themselves before hand, rather than it being implicitly added by the request to migrate, which I consider a good thing.
So, I propose to modify the migration process in this section to be something like:
Thoughts?
I generally find the language-specific formatting done by lstlisting
more annoying than beneficial. For instance in sec 4.2 of the document, the following stanza:
\begin{lstlisting}[language=sh]
git checkout main
git pull origin main
git checkout -b branch-name-for-change
\end{lstlisting}
formats it all monospaced apart from the "for" which is in bold face. In section 2, this one:
\begin{lstlisting}[language=sh,basicstyle=\footnotesize]
git clone --recurse-submodules https://github.com/msdemlei/ivoatexDoc
cd ivoatexDoc
make biblio # update the bibliography
make forcetex # make a PDF ignoring timestamps
make ivoatexDoc.html # make an html document
make package # make a zipfile for IVOA submission
\end{lstlisting}
for some reason typesets "cd" in bold, and the rest of it in monospaced although it does the comments (after the #) in italic, which is arguably an improvement.
I find this (not very) cleverness distracting and would generally just prefer the whole thing monospaced including the comments. Arguably the benefits are greater for language settings other than sh
, though e.g. it doesn't seem to be doing anything particularly smart for the archdiag example in sec 2.3.3 marked language=XML
.
Is it just me? It's partly a matter of taste, and I can cope either way, but given we're recommending particular usage of the lstlisting
package in ivoatexDoc I thought it was worth raising the question.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.