gtalarico / revitapidocs

Online Revit API Documentation: 2015, 2016, 2017, 2017.1, 2018
http://www.revitapidocs.com
33 stars 20 forks source link

Create Permalink / Human friendly url redirects for Resources #128

Closed gtalarico closed 4 years ago

gtalarico commented 6 years ago

[On behalf of @eirannejad]

Examples: revitapidocs.com?class=Autodesk.Revit.DB.FailureMessageAccessor or revitapidocs.com?latest=Autodesk.Revit.DB.FailureMessageAccessor or revitapidocs.com?link=Autodesk.Revit.DB.BuiltinCategory

The primary use case would be for using doc links in forums, code comments etc. This would ensure the link is permanent regardless of Revit version.

Todo:

eirannejad commented 6 years ago

There shouldn't be any ambiguous requests since you're including the full namespace. Voting up your link= and suggesting this format for the permalinks:

permalink = "revitapidocs.com?link=", symbol, { ".", symbol }, [ "->", doc_resource ];

-> is just a suggestion. [ ] works just as well.

Examples:

Wall class: revitapidocs.com?link=Autodesk.Revit.DB.Wall

Wall class, methods page: revitapidocs.com?link=Autodesk.Revit.DB.Wall->Methods

SketchPlane class, properties page: revitapidocs.com?link=Autodesk.Revit.DB.SketchPlane->Properties

Intersect method of PlanarFace class: revitapidocs.com?link=Autodesk.Revit.DB.PlanarFace.Intersect

CanFlipFacing property of FamilyInstance class: revitapidocs.com?link=Autodesk.Revit.DB.FamilyInstance.CanFlipFacing

Plane class, constructors page: revitapidocs.com?link=Autodesk.Revit.DB.Plane->Constructor

Plane(XYZ, XYZ) constructor of method of Plane class: revitapidocs.com?link=Autodesk.Revit.DB.Plane.Plane(XYZ,XYZ)

gtalarico commented 4 years ago

Only took one year 😊