[Bf-docboard] Propsal: fundamentals, citation

Campbell Barton ideasman42 at gmail.com
Tue Jun 14 19:23:09 CEST 2016


Hi Tobias,
are you proposing
http://blender-manual.readthedocs.io/en/testing/fundamentals/index.html
be moved to https://www.blender.org/manual/
and maintained in our subversion repository along with the rest of the manual?

On Tue, Jun 14, 2016 at 10:23 PM, Tobias Heinke
<heinke.tobias at t-online.de> wrote:
> Hello everyone,
>
> Fundamentals is ready to be applied, so here's a summary:
>
> What I'm proposing is to extend the glossary to be capable to hold
> additional content than just definitions (images, examples...).
>
> Then the glossary has to be subdivided (decentralization) and needs a
> structure.
>
> The aim is to move content from the manual to Funda.
> In general information that is not specific to Blender, because it is
> static, thus not has to be maintained.
>
> Especially used to removes duplicates, like the difference between
> perspective and orthographic,
> see appendix. Or content that is on introduction pages.
> There is not much added as currently is in the glossary and the manual.
>
> Funda still has compact definitions, that could be linked to by the term
> directive.
> Also the glossary index still works.
>
> demo:
> http://blender-manual.readthedocs.io/en/testing/fundamentals/index.html
>
>
> |> structured vs. central glossary
>
> pro
>
> move non blender specific content
> remove duplication in the manual
> additional content (images, examples ...) besides definitions
> not need to be maintained
> writing is more fun
> comparability of techniques
> no need of classification in the definition itself
> no one reads a a-z glossary top to bottom
> education
>
> contra
>
> a term could easily be added [terms are not added often]
>
>
> |> Citation
>
> I use citation of research papers as a tool to raise the text quality and
> also to protect intellectual property. Where the scientific standard is,
> that when to cite is depended on the common knowledge of the audience,
> which is in this case non experts.
>
> Citation is not possible under CC0, besides I generally don't want to
> publish under CC0,
> the license would need to be changed to CC-BY-SA.
>
>     https://developer.blender.org/D1948
>
>
> best regards,
> Tobias
>
>
> perspective : orthographic
> https://www.blender.org/manual/render/cycles/camera.html
> https://www.blender.org/manual/render/camera/lens.html
>
>
>
> Am 24.05.2016 um 17:02 schrieb Tobias Heinke:
>
> Hello,
>
> While working on Fundamentals I noticed, that it is an encyclopedia I'm
> writing:
> A structured glossary with definitions:
>
>     Rendering:
>     "[The] process of synthesizing an image from a given scene description
> is called rendering" [Geor15].
>
> So why not replace the a-z sorted glossary with Funda.
>
> Technically this is a decentralization of the glossary.  A small glossary
> for nearly each of the therms.
>
>     Headline
>
>     .. glossary::
>       term
>         definition
>
>     additional text about "term"
>
> With the benefit that content could be added, that is not fitting the strict
> formalism of a definition.
> i. e. definitions for beginners, that might me not as precise.
>
> But it could also be used so to move content out of the manual, to separate
> of Blender specific and 'universal' content.
> It based on the opinion, that you need a "operational" knowledge - i.e know
> what a mesh is.
>
> In the same way, I want to move Blender specific terms like "modifier",
> "lattice" from the central glossary into the manual (introduction pages).
>
> demo:
> http://blender-manual.readthedocs.io/en/testing/fundamentals/index.html
>
> Starting point for Funda:
>
> - minimal one definition per paragraph
> - all terms of the current glossary covered
> - mostly static structure
>
> If that run against the "community's vision" of the manual - please discuss
> this with me.
>
> Tobias
>
> -------------------------------------------------------------
> [Geor15] Iliyan Georgiev, 2015, Path Sampling Techniques for Efficient Light
> Transport Simulation;
>         PhD thesis, Saarland University, Saarbrücken, Germany.
>
>
> Am 18.03.2016 um 17:56 schrieb Tobias Heinke:
>
> Hello everybody,
>
> Blender Fundamentals has progressed...
> It toke a while, because I've worked parallel at several places in Funda
> to make sure theres a golden thread for the reader to follow along.
>
> here's the link;
> https://www.gitbook.com/book/tobiasheinke/blender-fundamentals/details
>
> It's only notes, but I hope it's clear (not cryptic) enough, to warm up
> the discussion:
> Whether it should be a standalone or merged into the manual?
>
> Content has to move from the Manual to Funda. or vice versa.
> This has to be planned. How to avoid duplicates - replace content?
>
> I urge you to write a comment. The project is at a neuralgic point -
> it's the last time where it's easy to restructure.
>
> Greetings
> Tobias
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard
>
>
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> https://lists.blender.org/mailman/listinfo/bf-docboard
>
>
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> https://lists.blender.org/mailman/listinfo/bf-docboard
>



-- 
- Campbell


More information about the Bf-docboard mailing list