Page MenuHome

DocumentationProject
ActivePublic

Details

Description

Blender Documentation (latest manual build)

Welcome to the Blender User Documentation project. We are actively searching for contributors and documentation module owners.

The Blender Manual is written using reStructuredText (RST) and is built with Sphinx.

If you want to start contributing or want to have a look at the manual, here we have some instructions.

How to build & edit the docs locally

Before you start contributing it may be helpful to read the style guides which give instructions on how to write with RST and some goals of the manual.

Now that you are familiar with the process, you can get setup, edit, and contribute your changes by following these links:

  1. Install
  2. Build
  3. Edit
  4. Build again
  5. Patch or Commit
NOTE: We realize this may be intimidating if you're not familiar with Subversion or making patches, you may also submit the modified file as a Phabricator task, or mail the bf-docboard mailing list.

Links

Manual Docs: Manual/About (the process for editing the manual).
Source Files: Manual Repository (subversion repository).
Mailing List: bf-docboard
Administrators: @Aaron Carlisle (Blendify) @Francesco Siddi (fsiddi)


Documentation Team

The coordination of the Blender Manual is run by a set of Administrators,
which are responsible for managing the whole project and infrastructures. (listed above)

If you are interested in becoming a contributor, please contact us on the bf-docboard mailing list.

Translations

For translations, we use Sphinx’s internationalization package. To get started see https://docs.blender.org/manual/en/dev/about/contribute/index.html#translations

Links

Source Files: Translation's Repository (subversion repository).
Forum: Documentation category on Developer Talk
Mailing List: bf-docboard
Administrators: @Aaron Carlisle (Blendify) , @Francesco Siddi (fsiddi)

NOTE: If you are a new translator who wants to start translating a new language that is not listed below send and email to the bf-docboard and we would be glad to set it up for you.

Recent Activity

Sun, Jan 20

Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Third retrieve is proceeding (slowly), and in ~4 days it should be finished. At that time (before running html processing for all pages) I need feedback about suggestion in T48096#594983 by @nBurn (nBurn) to change warning text (and add link to an explanatory page). @Inês Almeida (brita_), @Francesco Siddi (fsiddi), @Aaron Carlisle (Blendify), anyone: do you agree? What URL to add for explanatory page? Some page in new wiki? Or better to leave warning as it is now?

Sun, Jan 20, 5:26 PM · Documentation, Infrastructure: Websites

Sun, Jan 13

Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

It looks like old Mediawiki doesn't want to work nicely with php7. Also there's no guarantee that the result will look anything like the current one, so I guess its gonna be a new 10 d crawl..

Sun, Jan 13, 2:41 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Hi, I'm now contemplating to do another full retrieve, so this would be a perfect time to make decisions about suggestions from @nBurn (nBurn) in T48096#594983. Anyone else also want those changes?

Sun, Jan 13, 9:45 AM · Documentation, Infrastructure: Websites

Mon, Jan 7

Brecht Van Lommel (brecht) abandoned D4171: Fix T44508.

Thanks for the patch, but I don't think the intent of the original task was to add prefixes for In/Out. that should already be clear from the UI and not cause any problems in the Python API. Rather it was to rename to "Vector1" and "Vector2" for example.

Mon, Jan 7, 5:28 PM · Documentation, User Interface, Nodes, BF Blender
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Yes, the only special pages currently included are the edit and history pages. Technically, all those specials (non-existing parent page, what links here, recent user contributions for User:X pages) can be added, if someone else also seconds this motion? "What links here" and "recent user contributions" could be retrieved to e.g. links.html and contributions.html located under page folders. I don't think they would add too much to archive size, it would just take me time to do it.

Mon, Jan 7, 5:18 PM · Documentation, Infrastructure: Websites
Vaishnav S (padthai) added a reviewer for D4171: Fix T44508: User Interface.
Mon, Jan 7, 4:34 PM · Documentation, User Interface, Nodes, BF Blender
Vaishnav S (padthai) added reviewers for D4171: Fix T44508: Julian Eisel (Severin), William Reynish (billreynish).
Mon, Jan 7, 4:12 PM · Documentation, User Interface, Nodes, BF Blender
nBurn (nBurn) added a comment to T48096: New Wiki.

There seems to be some weirdness going on if wiki user's created subpages without a base page.

Mon, Jan 7, 12:41 AM · Documentation, Infrastructure: Websites

Sun, Jan 6

Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

I would keep all the deleted pages and their redirects. This would avoid broken links.

Sun, Jan 6, 5:13 PM · Documentation, Infrastructure: Websites
Inês Almeida (brita_) added a comment to T48096: New Wiki.

I would keep all the deleted pages and their redirects. This would avoid broken links.
I don't think that the asccii character issue is is a good compromise as this will result in broken links? Or maybe I misunderstood something.

Sun, Jan 6, 12:33 PM · Documentation, Infrastructure: Websites

Sat, Jan 5

Vaishnav S (padthai) retitled D4171: Fix T44508 from Revision for T44508 to Fix T44508.
Sat, Jan 5, 1:55 PM · Documentation, User Interface, Nodes, BF Blender
Vaishnav S (padthai) added a project to D4171: Fix T44508: Documentation.
Sat, Jan 5, 1:50 PM · Documentation, User Interface, Nodes, BF Blender

Wed, Jan 2

Brecht Van Lommel (brecht) closed T60037: Single column layout breaks file browser as Resolved by committing rB8063d72b08d2: Fix T60037: single column layout breaks file browse button..
Wed, Jan 2, 7:24 PM · User Interface, Documentation, BF Blender

Tue, Jan 1

Robert Guetzkow (rjg) added a comment to T60037: Single column layout breaks file browser .

I believe this is a bug and unless use_property_split should not be used in certain situations. If that is the case the documentation should reflect this.

Tue, Jan 1, 11:54 PM · User Interface, Documentation, BF Blender
Robert Guetzkow (rjg) added a project to T60037: Single column layout breaks file browser : User Interface.
Tue, Jan 1, 11:51 PM · User Interface, Documentation, BF Blender
Robert Guetzkow (rjg) renamed T60037: Single column layout breaks file browser from Single column layout breaks file dialog to Single column layout breaks file browser .
Tue, Jan 1, 4:27 PM · User Interface, Documentation, BF Blender
Robert Guetzkow (rjg) created T60037: Single column layout breaks file browser .
Tue, Jan 1, 4:24 PM · User Interface, Documentation, BF Blender

Mon, Dec 31

Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

Ok, new version of archived wiki is available temporarily for review at http://tkeskita.kapsi.fi/temp/en.blender.org/

  • Page list available in text and html formats. Pages now include also deleted pages and redirections to deleted pages. Page count is 53173 out of 53221, so almost everything seems to be included.
  • Includes index.html, edit.html and history.html pages for each wiki page. History page lists date and username of 50 latest edits.
  • Page names may contain underscores instead of spaces, and they should both be found. This was done by creating directory symlinks like "Release_Notes" that point to "Release Notes". Is this OK?
  • All links to en.blender.org in pages have been converted into relative paths, so this can be freely placed in any directory and links should work. Since the whole script size is now 350 lines, the current bash script is attached here:

Mon, Dec 31, 4:40 PM · Documentation, Infrastructure: Websites
Brecht Van Lommel (brecht) added a comment to T48096: New Wiki.

Agree, I wouldn't worry too much about fixing every broken link. It's nice if it doesn't take too much time, but for an archived website it's ok if only the basics are functional.

Mon, Dec 31, 2:15 PM · Documentation, Infrastructure: Websites

Sun, Dec 30

nBurn (nBurn) added a comment to T48096: New Wiki.

I wouldn't worry about saving the full edit history. I'm not sure how you could preserve that without a significant increase to the total size and file count of the wiki archive. It might be helpful to see who the last 50 or 100 people that edited the page are (and maybe the first 50 edits), but if someone needed more info than that they could download the wiki data dump.

Sun, Dec 30, 8:02 PM · Documentation, Infrastructure: Websites

Dec 21 2018

Brecht Van Lommel (brecht) added projects to T59721: GP: Primitive Documentation: Grease Pencil, Documentation.
Dec 21 2018, 5:34 PM · Documentation, Grease Pencil
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

I've been wondering about history pages. After pages are static it will not be possible to do comparisons between versions, so you will only see who edited the page last and when. Is it still interesting to save history page? @Inês Almeida (brita_)?

Dec 21 2018, 4:24 PM · Documentation, Infrastructure: Websites
LazyDodo (LazyDodo) added a comment to T48096: New Wiki.

I was browsing the scraped copy last week, and bumped into a searchbox somewhere, we'd probably have to get rid of those otherwise users will use them and make tickets that it is not working.

I guess you mean the quick search on lower left corner? Good idea! I'll also remove the "Page" menu from top right and "Wiki" menu from bottom right.

Dec 21 2018, 2:58 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.
  1. The old wiki contains deleted pages, such as this, which redirects to here which is deleted. wget does not want to download such pages. Is it OK to leave these pages out, or should I try to find some way to get also them in? My script is collecting a list of these failed pages, let's see how long it gets.
Dec 21 2018, 2:23 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

I was browsing the scraped copy last week, and bumped into a searchbox somewhere, we'd probably have to get rid of those otherwise users will use them and make tickets that it is not working.

Dec 21 2018, 2:03 PM · Documentation, Infrastructure: Websites
Nam-Quang Tran (qforce) added a comment to T59685: Prevent confusion regarding specular input of Principled Shader.

Understood. I've created a post on Right-Click Select: post

Dec 21 2018, 12:42 PM · Documentation, BF Blender

Dec 20 2018

Brecht Van Lommel (brecht) closed T59685: Prevent confusion regarding specular input of Principled Shader as Archived.

It's a good suggestion, but we don't handle this kind of usability suggestion in the bug tracker.
https://wiki.blender.org/wiki/Communication/Contact#User_Feedback_and_Requests

Dec 20 2018, 11:34 PM · Documentation, BF Blender
LazyDodo (LazyDodo) added a comment to T48096: New Wiki.

I was browsing the scraped copy last week, and bumped into a searchbox somewhere, we'd probably have to get rid of those otherwise users will use them and make tickets that it is not working.

Dec 20 2018, 9:20 PM · Documentation, Infrastructure: Websites
Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.
  1. @Dan McGrath (dmcgrath) : My script has stopped running a few times, wget says "Unable to establish SSL connection." When I try to continue, the page is loaded without errors. Any ideas what is causing this? I'm not choking the server, am I?
Dec 20 2018, 9:17 PM · Documentation, Infrastructure: Websites
Nam-Quang Tran (qforce) updated the task description for T59685: Prevent confusion regarding specular input of Principled Shader.
Dec 20 2018, 6:29 PM · Documentation, BF Blender
Nam-Quang Tran (qforce) updated the task description for T59685: Prevent confusion regarding specular input of Principled Shader.
Dec 20 2018, 6:20 PM · Documentation, BF Blender
Nam-Quang Tran (qforce) created T59685: Prevent confusion regarding specular input of Principled Shader.
Dec 20 2018, 6:19 PM · Documentation, BF Blender
noki paike (amonpaike) added a comment to T42765: Italian translation (Blender UI and manual).

@blend-it (blend-it) vorrei dare una mano nelle traduzioni e con il manuale in italiano..
piccoli compiti da eseguire..

Dec 20 2018, 5:31 PM · Documentation, Translations
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.
  1. The old wiki contains deleted pages, such as this, which redirects to here which is deleted. wget does not want to download such pages. Is it OK to leave these pages out, or should I try to find some way to get also them in? My script is collecting a list of these failed pages, let's see how long it gets.
  2. The old wiki contains pages with non-ascii characters in their page names, which at least my ext4 filesystem does not like to use correctly as directory name, such as this. I'm gonna convert all special characters in page names into %XX hexadecimal representation, using wget option --restrict-file-names=ascii. That way the pages will at least be downloaded, but I think they will not be found if you just try to access the static wiki like this, instead they would be accessible like this which makes it impossible to read. This affects only the page name, the page contents is still intact. Is this compromise acceptable? This affects only non-english pages.
  3. Just realized that the static wiki URL for "Page" would be "https://archive.blender.org/wiki/index.php/Page, so the base path is /wiki/index.php and not just /wiki. Is that OK?
  4. @Dan McGrath (dmcgrath) : My script has stopped running a few times, wget says "Unable to establish SSL connection." When I try to continue, the page is loaded without errors. Any ideas what is causing this? I'm not choking the server, am I?
Dec 20 2018, 5:03 PM · Documentation, Infrastructure: Websites

Dec 16 2018

Dan McGrath (dmcgrath) added a comment to T48096: New Wiki.

Does the wiki log whenever someone tries to visit a missing page? That would be a good way to identify broken links.

Dec 16 2018, 6:55 PM · Documentation, Infrastructure: Websites
Tuomo Keskitalo (tkeskita) added a comment to T48096: New Wiki.

@Benjamin Humpherys (brhumphe) I don't know about mediawiki, but at least www server logs errors. Good idea to use those to make the final check, when I get there!

Dec 16 2018, 9:48 AM · Documentation, Infrastructure: Websites

Dec 15 2018

Inês Almeida (brita_) updated the task description for T48096: New Wiki.
Dec 15 2018, 9:43 PM · Documentation, Infrastructure: Websites
Inês Almeida (brita_) added a comment to T56342: FIle downloads: re-evaluate .

@Sergey Sharybin (sergey) why do you think the licensing rule is strict?
A public domain diagram of an algorithm can be uploaded with its original license and author if needed. I think public domain, other versions of CC and the licenses used in the previous Blender wiki are all perfectly fine.
The Blender Cloud says: "Unless notified otherwise, all digital content (webpages, video, artwork, 3D data) is available under the Creative Commons Attribution 4.0.". Blender Cloud textures are CC0. So these can also be uploaded with their original license.

Dec 15 2018, 5:55 PM · Documentation
Sergey Sharybin (sergey) added a comment to T56342: FIle downloads: re-evaluate .

@Inês Almeida (brita_), i am all for keeping things locally in terms where they belong to. Makes it easier to version, control consistency, and see where they actually are supposed to be put.

Dec 15 2018, 5:33 PM · Documentation
Inês Almeida (brita_) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

I am very sorry to hear this. I am also sorry that I took over a week replying.
Please don't be discouraged by feedback or by people disagreeing, it only means that people care.
Specially with text, there can be endless discussions about wording and commas which can be frustrating.
Maybe you picked controversial topics? Can you give a second try to writing new content? With 2.8 there are exciting new opportunities to write entirely new chapters about Grease Pencil Object layers, groups and visibility.
The Blender documentation needs *you* :)

Dec 15 2018, 5:31 PM · Documentation
Inês Almeida (brita_) updated subscribers of T56342: FIle downloads: re-evaluate .

It's been some time without a reply.
@Sergey Sharybin (sergey) @Campbell Barton (campbellbarton) do you have anything against putting media files in the manual SVN under a new files/ folder in the root directory?

Dec 15 2018, 4:55 PM · Documentation
Tuomo Keskitalo (tkeskita) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

thanks for your comment! Yes I abandoned my remaining few open tasks related to Blender Manual. My work during last month on Blender Manual has received mostly negative feedback and only few positive comments. I concluded that it is best for me to work on something else.

Dec 15 2018, 4:26 PM · Documentation
Brecht Van Lommel (brecht) added a comment to T51172: Blender Documentation Roadmap.

Yeah sure, except for "incrementally make changes" it's doesn't works and likely ends up in a mess.

Dec 15 2018, 3:55 PM · Documentation
Inês Almeida (brita_) added a comment to T51172: Blender Documentation Roadmap.

@Tuomo Keskitalo (tkeskita) I tend to agree with the other comments.
Updating the manual to 2.8 is already a huge task and I don't think it's very realistic to restructure it at the same time.
It would already be wonderful if you would pick up one section for something that is new or completely changed and make sure that's well documented.
Try the grease pencil! This is a very popular area that people are beginning to experiment with, including people who are totally new to Blender. It would be great to have official docs for it and a list of handpicked video tutorials to see different workflows and what can be achieved.

Dec 15 2018, 3:14 PM · Documentation
Inês Almeida (brita_) added a comment to T48381: Move old release logs to the wiki.

Hey @Aaron Carlisle (Blendify) can this be closed?

Dec 15 2018, 2:48 PM · Documentation
Inês Almeida (brita_) added a comment to D4015: Use of upper and lower case letters in Blender Manual.

Hi @Tuomo Keskitalo (tkeskita) you seemed to have abandoned the revisions to improve the clarity of the rules for writing the Blender Manual.
Is there a problem? It think it was a really good effort!

Dec 15 2018, 1:01 PM · Documentation
Julien DUROURE (julien) added a reviewer for D4082: Documentation for glTF 2.0 exporter: Aaron Carlisle (Blendify).

@Aaron Carlisle (Blendify) : I don't know exactly how documentation repo is managed. Can you please review this documentation page for glTF importer/exporter?
Is it possible to have commit access on the repo to be able to update this page later ?

Dec 15 2018, 8:38 AM · Documentation

Dec 14 2018

Don McCurdy (donmccurdy) created D4082: Documentation for glTF 2.0 exporter.
Dec 14 2018, 11:18 PM · Documentation
Brecht Van Lommel (brecht) added a member for Documentation: Richard Antalik (ISS).
Dec 14 2018, 2:54 PM

Dec 12 2018

Tuomo Keskitalo (tkeskita) removed a watcher for Documentation: Tuomo Keskitalo (tkeskita).
Dec 12 2018, 7:36 PM