] ANN [Vellum 0.16:大量的文档和观看 [英] ]ANN[ Vellum 0.16: Lots Of Documentation and Watching

查看:112
本文介绍了] ANN [Vellum 0.16:大量的文档和观看的处理方法,对大家解决问题具有一定的参考价值,需要的朋友们下面随着小编来一起学习吧!

问题描述

大家好,


刚发布公告,我已经发布了新版本的

Vellum编号为0.16。这个版本应该可供人们使用

,因为很多内部结构在很多

提交中都没有变化,它包含所有最新的错误修复。 />

它还有一个广泛的PDF文档的开头,描述了

如何使用它。这仍然是一项正在进行的工作,所以它有语法错误和拼写错误,但它确实展示了一些很好的

文档向导我正在尝试LaTeX。


最后还有一个新的手表功能非常方便描述

进一步向下。当文件发生变化时,它只是观察文件并重新运行你的目标。

获得它


老实说,最简单的方法是只需:


sudo easy_install zapps vellum


如果你想自己制作这本书并拥有所有的TeX Live
$ b安装$ b然后你还需要:


sudo easy_install pygments idiopidae


你也可以点击 http://launchpad.net/vellum/ 页面获取源代码

tarballs等好东西。

小册子


你可以在以下网站上获取最新的草稿:

http://zedshaw.com/projects/vellum/manual-final.pdf


任何有关如何编写的更正或评论超过

欢迎。改进TeX的建议也很有用,因为我还不是TeX专家。


我用来构建那本书的软件完全可供任何人使用

来记录他们的项目。你可以从互联网上抓住Idiopidae,Pygments,

和TeX。然后你可以从我的Bazaar存储库获取整个源代码和所有

LaTeX善良:


bzr pull http://zedshaw.com/repository/vellum/


查看文档/目录所有的乐趣。您会注意到

.tex文件中包含* no *代码,并且它全部由

Idiopidae导入。查看doc / book.vel文件,看看它们是如何合并的,然后按下它们,并且你可以重复使用这个book.vel文件来启动

你的文件自己的书。

疯狂的手表功能


我为Vellum添加了一个功能,即duh中的一个。特征。你可以告诉Vellum看一个文件,如果它改变了,Vellum会重新运行一些目标。当我处理manual.tex文件时,我这样做:


vellum -w doc / manual.tex book.draft book.view


它只是保持循环,如果你按CTRL-C你可以强制使用

ENTER构建或使用CTRL-C退出。然后我在

linux下使用evince PDF查看器,它有类似的Vim键绑定,并在它改变时重新加载PDF。


这个的净效果是,每当我更改我的manual.tex文件时,Vellum

运行我的构建手册,并重新显示它让我看。


你可以使用这个简单的功能连续运行单元测试

每当你正在处理的文件发生变化时。


GPLv3?


人们如何看待Vellum的GPLv3状态?除非你将Vellum嵌入到一个项目/产品中,否则它实际上不会对任何人造成影响,或者你需要创建命令(无论如何都要回馈)。即便如此,如果你从不向你的用户发布你的构建,那么你就不需要发布

命令了。


但是,我很想得到其他人的想法。


感谢一大群人。


-

Zed A. Shaw

- 讨厌: http:// savetheinternetwithhate.com/

- 好: http:// www.zedshaw.com/

- 邪恶: http:// yearofevil.com/

Hi Everyone,

Just putting out an announcement that I''ve released a new version of
Vellum numbered 0.16. This version should be ready for people to use
as not much of the internal structure has changed in a great many
commits and it contains all the latest bug fixes.

It also has the beginning of an extensive PDF document describing how
to use it. This is still an in-progress work, so it has grammar
mistakes and spelling errors, but it does show off some nice
documentation wizardy I''m experimenting with in LaTeX.

Finally there''s a new "watch" feature which is very handy described
further down. It simply watches a file and reruns your targets when
the file changes.
GETTING IT

Honestly, the easiest way is just:

sudo easy_install zapps vellum

If you want to build the book yourself and have all of TeX Live
installed then you''d also need:

sudo easy_install pygments idiopidae

You can also hit the http://launchpad.net/vellum/ page to grab source
tarballs and other goodies.
THE BOOK OF VELLUM

You can grab the most recent draft of the book at:

http://zedshaw.com/projects/vellum/manual-final.pdf

Any corrections or comments on how it is written are more than
welcome. Suggestions for improving the TeX are also helpful since I''m
not a TeX expert yet.

The software I''m using to build that book is fully available to anyone
looking to document their projects. You can grab Idiopidae, Pygments,
and TeX from the interwebs. You can then grab the whole source and all
the LaTeX goodness from my Bazaar repository:

bzr pull http://zedshaw.com/repository/vellum/

Look in the doc/ directory for all the fun. You''ll notice that
the .tex files have *no* code in them, and that it''s all imported by
Idiopidae. Look at the doc/book.vel file to see how it''s all merged
and massaged together, and you can reuse this book.vel file to start
your own books.
CRAZY NICE WATCH FEATURE

I added a feature to Vellum that is one of those "duh" features. You
can tell Vellum to watch a file, and if it changes Vellum will rerun
some targets. When I work on the manual.tex file, I do this:

vellum -w doc/manual.tex book.draft book.view

It just keeps looping, and if you hit CTRL-C you can force a build with
ENTER or quit with CTRL-C. Then I use the evince PDF viewer under
linux, which has similar Vim key bindings and reloads the PDF when it
changes.

The net effect of this is, whenever I change my manual.tex file, Vellum
runs my build for the manual and evince redisplays it for me to see.

You could use this simple feature to also continually run unit tests
whenever a file changes that you are working on.

GPLv3?

How do people feel about Vellum''s GPLv3 status? It actually doesn''t
impact anyone unless you embed Vellum into a project/product or you
create commands (which you should give back anyway). Even then if you
never release your build to your users then you don''t need to release
the commands.

However, I''m curious to get other people''s thoughts.

Thanks a bunch folks.

--
Zed A. Shaw
- Hate: http://savingtheinternetwithhate.com/
- Good: http://www.zedshaw.com/
- Evil: http://yearofevil.com/

推荐答案

" Zed A. Shaw" < ze ***** @ zedshaw.comwrites:
"Zed A. Shaw" <ze*****@zedshaw.comwrites:

刚发布一条公告,我发布了新版本的

Vellum编号为0.16。
Just putting out an announcement that I''ve released a new version of
Vellum numbered 0.16.



在宣布Foo软件​​的新版本时,请始终包括

(靠近顶部)aWhat is Foo?或关于Foo或部分,让人们知道你在说什么以及为什么它与论坛有关。

When announcing new versions of Foo software, please always include
(near the top) a "What is Foo?" or "About Foo" section, so that people
know what you''re talking about and why it''s relevant for the forum.


GPLv3?


人们如何看待Vellum的GPLv3状态?
GPLv3?

How do people feel about Vellum''s GPLv3 status?



GPLv3并非没有问题,但它是一个不错的Copyleft许可证。

我很高兴看到更多的软件GPLv3而不是许可证

不那么严格确保软件保持免费,所以谢谢你。


-

\ a一个自由的新闻是一个可以说明由于证据而导致的结论。 a ??比尔莫耶斯|

_o__)|

Ben Finney

The GPLv3 is not without problems, but it''s a decent copyleft license.
I''m happy to see more software under the GPLv3 rather than licenses
less rigorous about ensuring the software remains free, so thankyou.

--
\ a??A free press is one where ita??s okay to state the |
`\ conclusion youa??re led to by the evidence.a?? a??Bill Moyers |
_o__) |
Ben Finney


4月29日上午9:51 ,Zed A. Shaw, < zeds ... @ zedshaw.comwrote:
On Apr 29, 9:51 am, "Zed A. Shaw" <zeds...@zedshaw.comwrote:

但是,我很想得到其他人的想法。
However, I''m curious to get other people''s thoughts.



关于许可证的问题,我会说GPL3很好:

工具基本上任何类型的许可都没问题,

因为该工具在代码外部,所以这是一个小问题。

我很好奇其他两件事,不过,或许在
$中回答b $ b书,但我没有时间阅读。第一个问题:你是说

,vellum不会跟踪已经构建的文件,并且每次重新编译

所有内容,即它实际上与

make和类似的构建工具?

第二个问题:docutils怎么样? Pythonista希望使用一个

文档工具来使用reST,我相信我们很多人会在reST中有文章/文件(甚至是书籍),并且会是

有兴趣建造它们。 OTOH我不会对

学习另一种轻量级标记语言或回到TeX感兴趣。

Vellum书是用reST写的吗?

Michele Simionato

For what concerns the license, I would say that GPL3 is fine:
for a tool basically any kind of license is fine,
since the tool is external to the code, so this is a minor point.
I am curious about two other things, though, perhaps answered in the
book but I had no time to read it all. First question: are you saying
that vellum does NOT keep track of already built files and recompile
everything each time, i.e. it is really in a different ballpark from
make and similar build tools?
Second question: what about docutils? A Pythonista would expect a
documentation tool to use reST and I am sure plenty of us out
there have articles/documents (even books) in reST and would be
interested in building them. OTOH I would not be interested in
learning yet another lightweight markup language or to go back to TeX.
Is the Vellum book written in reST?
Michele Simionato


4月29日凌晨3:51,Zed A. Shaw < zeds ... @ zedshaw.comwrote:
On Apr 29, 3:51 am, "Zed A. Shaw" <zeds...@zedshaw.comwrote:

您可以在以下网址获取该书的最新草稿:

http://zedshaw.com/projects/vellum/manual-final.pdf


但是,我很想得到其他人的想法。
However, I''m curious to get other people''s thoughts.



IMO如果您不在手册中使用脏话,那么它将有助于扩大其覆盖范围和接受度。


i。

IMO if you would refrain from using swear words in the manual it would
help broadening its reach and acceptance.

i.


这篇关于] ANN [Vellum 0.16:大量的文档和观看的文章就介绍到这了,希望我们推荐的答案对大家有所帮助,也希望大家多多支持IT屋!

查看全文
登录 关闭
扫码关注1秒登录
发送“验证码”获取 | 15天全站免登陆