[Bf-docboard] Proposal for wiki -> manual redirects

Jambay Jambay at cox.net
Sat Jun 6 10:40:37 CEST 2015


Yes, thought ;) agreed.

A simple reference within each wiki page just like an external link would be 
great.

I'm still working on existing pages and want to transfer to new system.

----- Original Message ----- 
From: "gandalf3" <zzyxpaw at gmail.com>
To: "Blender Documentation Project" <bf-docboard at blender.org>
Sent: Friday, June 05, 2015 6:00 PM
Subject: [Bf-docboard] Proposal for wiki -> manual redirects


> Since our conversation on IRC ended up rather confused, hopefully I can
> clarify what my idea is.
>
> The goal is to redirect wiki pages to corresponding manual pages with a
> system which allows any documentor to quickly and easily add redirects
> as they are noticed.
> My proposed solution is to:
>
> 1. Define redirects by placing a special comment inside the manual
> page's source, containing the wiki page path.
> For example, you might put something like this:
>
>     .. _wiki-redirect: /Doc:2.6/Manual/Render/Cycles/Nodes/Shaders
>
> In the rEST source of
> http://blender.org/manual/render/cycles/nodes/shaders.html.
>
> This would be easy to add when editing manual pages for other reasons,
> and would not require any extra actions when moving pages around inside
> the manual.
>
> 2. Compile these urls into a list via a script which searches *.rst
> files for these comments, and uses the path of the *.rst file containing
> the comment as the destination of the redirect. So the example above
> would generate output like:
>
> /Doc:2.6/Manual/Render/Cycles/Nodes/Shaders ->
> /manual/render/cycles/nodes/shaders
>
> 3. Use the resulting list (formatted however it needs to be) to perform
> redirection from the wiki, perhaps using the mediawiki redirection
> system Dan mentioned?
>
>
> Hope that clarifies things :)
> Any thoughts?
>
> -- 
> -gandalf3
>
> _______________________________________________
> Bf-docboard mailing list
> Bf-docboard at blender.org
> http://lists.blender.org/mailman/listinfo/bf-docboard 



More information about the Bf-docboard mailing list