Contribute Posts

Guidelines

  • Posts must be in Markdown.

  • Must be in English

  • Topics should be focused on automating CATIA workflows using EKL, Knowledge-ware, xGenerative Design, C-Sharp, VBA, VbScript, CAA, CATScript, or CATRules. Of course, your post can focus on interfacing with other tools (Rhino, REVIT, Inventor, Excel, etc).

  • Use three hash tags to format section headings. This will be rendered as Heading 3 in HTML. Heading 3 works best with the current blog theme. If you need a subsection, use five hashtags. Other headings can be made bold using double asterisks before and after. Try to avoid deeper nesting.

  • Provide code. Code blocks should use the syntax highlighting.

    • For EKL use “javascript”
    • For CATScript, VBScript, VBA use “vbnet”
    • For C-Sharp use “csharp”
  • Include the 3DXML file containing the example files. Make a pull request to add your files to the blog repo on bitbucket. I’ll send you details on how to do so.

  • Topics submitted should try to be short. They should aim to show the reader how to achieve a certain task; or explain the concept behind a certain functionality. Here is a good post format:

  • Start with problem description, scenario, current status quo of how things are done, an existing workflow, or a description of useful feature. Then explain how the solution can be built and/or used to make tasks easier.

  • Please make sure your writing is clear, easy to follow, and free of typos. A good way to go about this is to have a few of your colleagues review and edit your post before submitting.

  • Please make sure to refer to topics, items, or concepts correctly. For example, CATIA V5 is different from CATIA V6, which is different from CATIA 3D Experience. If you’re unsure, please send an email to inquire.

  • Demonstrate steps for building or using the solution you describe in your post via silent video (Screen recording) if possible. If submitted, videos must be in mp4 format. Videos must be FHD(1920 x1080). Video duration should be short to make it loads quickly. It is better to provide multiple videos covering multiple steps instead of one video showing all steps. To record a video, I use screentogif then convert them to mp4 on convertio. Both are free.

Rights

  • Above guidelines may be revised.

  • You’ll get a Contributor role on the blog, which allows you to write and upload content for review.

  • Submitting posts does not necessarily mean that they will be published, at least not right away.

  • Your posts will be reviewed. If the content is deemed suitable, it will be published.

  • Once your post is published, making edits will go through a review process again.

  • Your account will allow you to delete your posts if you wish, at any time. No questions asked.

  • The blog editors hold the right to edit or remove posts as seen fit. No questions entertained.

  • If a post is removed, it will be still accessible to you, the author. This allows you to download the content if you have not kept a backup already.

  • You can republish your posts on other websites. If you do so, please make note of this on your blog post.

  • Unlike code (which can be copied from different places), posts should come from you, the author. Please submit original content, or include inline links to posts you are referencing. Intended plagiarism will cause your account and posts to be removed

  • As of now, the blog is not sponsored nor does it run ads. Content is provided for free to help others learn. As such, there is no financial compensation for submitting posts. The assumption here is that contributors send posts because they believe in the same goal!

  • In the event the blog generates revenue, via sponsorship, ads, or the likes, revenue will be distributed to contributors, retroactively. However, this will come after covering the blog web hosting costs.

Get In Touch

Send a message expressing interest in becoming a contributousing the contact form and I’ll reach out with further details.